Skip to content
This repository has been archived by the owner on Dec 6, 2024. It is now read-only.

Create a new release

Jeffrey Jangli edited this page Jun 14, 2018 · 7 revisions

Creating the release

  • Create a new branch named release/2.2 for example from the "develop" branch (if a major release), or from "master" branch if a minor bug-fix release.
  • Update the version number and releaseNotes in AlphaFS.nuspec
  • Update the version numbers in AssemblyVersionInfo.cs
  • Update the version number ('Help file version') in AlphaFS.Doc (properties)
  • Update the copyright notice in AlphaFS.Doc (properties)
  • Update the CHANGELOG.MD: Version, Date, Issues (be sure to give credits)
  • Commit and push the changes.
  • From a developer command prompt, run msbuild BuildRelease.proj from the AlphaFS root directory.
  • If no errors occurred, the Dist directory under the AlphaFS root should now contain a zip-file with binaries as well as a nupkg file to upload to NuGet.
  • Push your changes to GitHub.
  • Create a new release on GitHub, target master or develop, depending. Add the zip file.
  • Upload the AlphaFS.XXX.nupkg file from the Dist directory to NuGet.
  • Merge the Release-branch back down to the branch it originated from.
  • If a major release, merge develop to master and push.

Update online documentation for a major release

  • Checkout the gh-pages branch
  • Create a version directory under the doc/ directory, for example doc/2.2.
  • Create a directory doc/2.2/api.
  • From the Bin/Documentation directory of your build, copy all files to the newly created api directory.
  • Copy the index.html file from a previous version into the doc/2.2 directory.
  • In the _config.yml file in the root of the gh-pages branch, add a submenu for the current version. (Just copy the two lines from a previous version and update the url and title)
  • In the _posts directory, copy a previous release note and rename it accordingly (starting with the date), and update its contents.
  • Update the CHANGELOG.md file in the gh-pages branch by copying the relevant entries from the main branch. (Note that the files are not identical, the one in gh-pages contains a bit of yml headers, so don't just replace it)
  • Commit and push the gh-pages branch.
  • Check the web site and verify that everything looks good. (It may take a couple of minutes between pushing the branch and the changes appearing on the site).