Skip to content

Latest commit

 

History

History
34 lines (21 loc) · 4.6 KB

PUBLISHING.md

File metadata and controls

34 lines (21 loc) · 4.6 KB
Raw

How to Publish a New Version

The code to be published should be in the main branch. Make sure that all the PRs to go in the release are merged, and decide on the release tag. Should it be a release candidate or the final tag, and should it be a major, minor or patch release, per semver rules.

Once ready to do a release, create a local branch that includes the following updates:

  1. Create a PR branch from an updated main branch.

  2. Update the CHANGELOG.md to add the new release. Only create a new section when working on the first release candidate for a new release. When transitioning from one release candidate to the next, or to an official release, just update the title and date of the change log section.

  3. Include details of the merged PRs included in this release. General process to follow:

  • Gather the set of PRs since the last release and put them into a list. A good tool to use for this is the github-changelog-generator. Steps:
    • Create a read only GitHub token for your account on this page: https://github.com/settings/tokens with a scope of repo / public_repo.
    • Use a command like the following, adjusting the tag parameters as appropriate. docker run -it --rm -v "$(pwd)":/usr/local/src/your-app githubchangeloggenerator/github-changelog-generator --user hyperledger --project aries-cloudagent-python --output 0.7.4-rc0.md --since-tag 0.7.3 --future-release 0.7.4-rc0 --release-branch main --token <your-token>
    • In the generated file, use only the PR list -- we don't include the list of closed issues in the Change Log.
  • Organize the list into suitable categories, update (if necessary) the PR description and add notes to clarify the changes. See previous release entries to understand the style -- a format should help developers.
  • Add a narrative about the release above the PR that highlights what has gone into the release.

  1. Update the ReadTheDocs in the /docs folder by following the instructions in the docs/README.md file. That will likely add a number of new and modified files to the PR. Eliminate all of the errors in the generation process, either by mocking external dependencies or by fixing ACA-Py code. If necessary, create an issue with the errors and assign it to the appropriate developer. Experience has demonstrated to use that documentation generation errors should be fixed in the code.

  2. Update the version number listed in aries_cloudagent/version.py and, prefixed with a "v" in open-api/openapi.json (e.g. "0.7.2" in the version.py file and "v0.7.2" in the openapi.json file). The incremented version number should adhere to the Semantic Versioning Specification based on the changes since the last published release. For Release Candidates, the form of the tag is "0.7.2-rc0".

  3. An extra search of the repo for the existing tag is recommended to see if there are any other instances of the tag in the repo. If any are found to be required (other than in CHANGELOG.md and the examples in this file, of course), finding a way to not need them is best, but if they are needed, please update this document to note where the tag can be found.

  4. Double check all of these steps above, and then submit a PR from the branch. If there are still further changes to be merged, mark the PR as "Draft", repeat ALL of the steps again, and then mark this PR as ready and then wait until it is merged.

  5. Immediately after it is merged, create a new GitHub tag representing the version. The tag name and title of the release should be the same as the version in aries_cloudagent/version.py. Use the "Generate Release Notes" capability to get a sequential listing of the PRs in the release, to complement the manually curated Changelog. Verify on PyPi that the version is published.

  6. Publish a new docker container on Docker Hub (bcgovimages/aries-cloudagent) by following the README.md instructions to create a PR for the release in the repository https://github.com/bcgov/aries-cloudagent-container. Appropriate permissions are required to publish the image.

  7. Update the ACA-Py Read The Docs site by building the new "latest" (main branch) and activating and building the new release. Appropriate permissions are required to publish the new documentation version.