Skip to content

Commit

Permalink
Merge pull request #2233 from valory-xyz/chore/update-release-process
Browse files Browse the repository at this point in the history
Update release process
  • Loading branch information
angrybayblade authored May 30, 2024
2 parents 2db5c40 + b9edc20 commit a616f0e
Showing 1 changed file with 14 additions and 12 deletions.
26 changes: 14 additions & 12 deletions scripts/RELEASE_PROCESS.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,27 +3,29 @@

1. Make sure all tests pass, coverage is at 100% and the local branch is in a clean state (nothing to commit). Make sure you have a clean develop virtual environment.

2. Determine the next `open-autonomy` version. Create new release branch named `feature/release-{new-version}`, switch to this branch.
2. Determine the next `open-autonomy` version. Create new release branch named `release/{new-version}`, switch to this branch.

3. Update the version in following files and commit if satisfied.
3. Make sure all the dependencies are pinned correctly across all of the file, special `open-aea` and the plugins.

4. Run `autonomy packages sync --update-packages --source valory-xyz/open-aea@v{latest-aea-version}` and `tox -e lock-packages`. Commit if satisfied.

5. Update the version in following files and commit if satisfied.
- `autonomy/__version__.py`
- `tests/test_base.py`
- `deployments/Dockerfiles/autonomy-user/requirements.txt`

4. Determine the next `open-aea-test-autonomy` version. Update the version in `plugins/aea-test-autonomy/setup.py` and relevant component configurations. Commit if satisfied.

5. [CURRENTLY SKIPPED] Bump all the packages to their latest versions by running `python scripts/update_package_versions.py`.
6. Determine the next `open-aea-test-autonomy` version. Update the version in `plugins/aea-test-autonomy/setup.py` and relevant component configurations. Commit if satisfied.

6. Check the package upgrades are correct by running `tox -e check-packages`. Commit if satisfied.
7. Check the package upgrades are correct by running `tox -e check-packages`. Commit if satisfied.

7. Check the docs are up-to-date by running `tox -e generate-api-documentation`. Ensure all links are configured and run `tox -e docs`. Commit if satisfied.
8. Check the docs are up-to-date by running `tox -e generate-api-documentation`. Ensure all links are configured and run `tox -e docs`. Commit if satisfied.

8. Make sure hashes are up-to-date and run `tox -e fix-doc-hashes`.
9. Make sure hashes are up-to-date and run `tox -e fix-doc-hashes`.

9. Write release notes and place them in `HISTORY.md`. Add upgrading tips in `upgrading.md`. If necessary, adjust version references in `SECURITY.md`. Commit if satisfied.
10. Write release notes and place them in `HISTORY.md`. Add upgrading tips in `upgrading.md`. If necessary, adjust version references in `SECURITY.md`. Commit if satisfied.

10. Run spell checker `tomte check-spelling`. Run `pylint --disable all --enable spelling ...`. Commit if required.
11. Run spell checker `tomte check-spelling`. Run `pylint --disable all --enable spelling ...`. Commit if required.

11. Open PRs and merge into develop. Then open develop to main PR and merge it.
12. Open PRs and merge into develop. Then open develop to main PR and merge it.

12. Tag version on main.
13. Tag a release from main.

0 comments on commit a616f0e

Please sign in to comment.