Release Process

Steps

1. Update the version in version.py
2. Update the changelog in HISTORY.rst
3. If there are any changes related to codegen runtime in azure-cli-core, please update MIN_CLI_CORE_VERSION in src/aaz_dev/utils/config.py
4. Update the document version in docs/_config.yml
5. Commit the above changes and create a pull request.
6. After the pull request is merged, create a new tag with the latest commit which will trigger a workflow on GitHub Actions:

   $ git tag <"v" + version> -m <"v" + version>
   $ git push upstream <"v" + version>

7. After the GitHub release is completed, trigger the PyPI release on ADO pipeline https://dev.azure.com/azclitools/release/_release?view=all&_a=deployments&definitionId=30

Fixing a failed release

If for some reason the GitHub Actions release workflow failed with an error that needs to be fixed, you'll have to delete both the tag and corresponding release from GitHub. After you've pushed a fix, delete the tag from your local clone.

Then repeat the steps above.