From ed25a42e448ba32398c7a636cd81d9d1fdc9bbaa Mon Sep 17 00:00:00 2001 From: Salman Mohammed Date: Fri, 11 Oct 2024 13:48:59 -0400 Subject: [PATCH 1/2] add release instructions to CONTRIBUTING.md --- CONTRIBUTING.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 783a010a6..d66578fa7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -73,6 +73,16 @@ Additions to the [developer toolkit][developer] change the core performance, and This project follows the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification for PR titles. Conventional Commits make it easier to understand the history of a project and facilitate automation around versioning and changelog generation. +## Release + +In order to release a new version of sq goose, you need to do the following: +1. Update CHANGELOG.md. To get the commit messages since last release, run: `just release-notes` +2. Update version in `pyproject.toml` for `goose` and package dependencies such as `exchange` +3. Create a PR and merge it into main branch +4. Tag the HEAD commit in main branch. To do this, switch to main branch and run: `just tag-push` +5. Publish a new release from the [Github Release UI](https://github.com/block-open-source/goose/releases) + + [issues]: https://github.com/block-open-source/goose/issues [goose-plugins]: https://github.com/block-open-source/goose-plugins [ai-exchange]: https://github.com/block-open-source/goose/tree/main/packages/exchange From bed61453a34e355c101414e764500be83d625692 Mon Sep 17 00:00:00 2001 From: Salman Mohammed Date: Fri, 11 Oct 2024 14:24:25 -0400 Subject: [PATCH 2/2] Update CONTRIBUTING.md --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d66578fa7..1a5597e44 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -75,7 +75,7 @@ This project follows the [Conventional Commits](https://www.conventionalcommits. ## Release -In order to release a new version of sq goose, you need to do the following: +In order to release a new version of goose, you need to do the following: 1. Update CHANGELOG.md. To get the commit messages since last release, run: `just release-notes` 2. Update version in `pyproject.toml` for `goose` and package dependencies such as `exchange` 3. Create a PR and merge it into main branch