Skip to content

Making_a_new_release.md

Latest commit

 

History

History
55 lines (45 loc) · 2.82 KB

Making_a_new_release.md

File metadata and controls

55 lines (45 loc) · 2.82 KB

Making a new release

This is the procedure we use for create a new release of Firecrown.

  1. Create a local branch in your clone of the repo to be used for the PR that will be started later. Name it for the new release, e.g.: prep-v1.10. Note that this is not the branch that would be used for bug fixes. A bug fix branch would only be created at the time it becomes necessary.

  2. Make sure you have updated the environment.yml file to release, or force, any versioning required.

  3. Update your local conda environment using conda env update --file environment.yml --prune -q --json.

  4. Make sure any new directories are being processed by black, flake8, mypy, and pylint.

  5. Update the version in firecrown/version.py (this is the ONLY file you need to edit manually).

  6. Update the tutorial version metadata by running:

    python tutorial/update_quarto_version.py

  7. Make sure all tests pass, all code checking is passed, all examples are working. Run these commands to verify:

    bash pre-commit-check

  8. Make sure the documentation builds:

    bash check-docs

  9. Make sure that any new features introduced are described, and any features removed from the code have been removed, in the tutorial.

  10. Commit and push all the changes to the new branch for the PR. This can be done either through the web interface, or through the gh command line utility.

  11. Create a PR for the generation of the new release. The CI system will automatically run on the PR.

  12. If the CI system complains, fix things and iterate as needed.

  13. When the CI system passes, merge the PR.

  14. Use the GitHub web interface to tag the commit. Allow the automated system to generate the release notes. Make sure "Set as the latest release" is checked (or Conda will not find it).

  15. Create the new conda release. This can be done through the web interface at https://github.com/conda-forge/firecrown-feedstock. Create a new issue. From the pop-up window, choose "Bot commands" In the next pop-up, set the title to be "@conda-forge-admin, please update version" (without the quotes).

    The PR will be created by the bot. Look at the files modified in the PR. In the recipe directory, look at meta.yaml. Update any versions needed. Then add a comment "@conda-forge-admin, please rerender" to the PR. Wait for the github actions to do their thing. Check and approve the PR. When they are all done, merge th PR.

  16. Immediately change the version in firecrown/version.py to the next development version, then run python tutorial/update_quarto_version.py to update the tutorial. If the release just made is x.y.z, the new development version should be x.y.(z+1)a0 (where 'a0' indicates alpha/development status). For example: if you just released 1.8.3, change to 1.8.4a0.