From fc463b4fb5d8bef36e3e760fe7b4382161eaba9b Mon Sep 17 00:00:00 2001 From: i0n Date: Wed, 20 Nov 2024 16:37:13 +0000 Subject: [PATCH] chore: update release docs and remove release script --- contributing.md | 48 +++++++++------------------------------------- scripts/release.sh | 21 -------------------- 2 files changed, 9 insertions(+), 60 deletions(-) delete mode 100755 scripts/release.sh diff --git a/contributing.md b/contributing.md index 47c3812..8a4d8db 100644 --- a/contributing.md +++ b/contributing.md @@ -7,7 +7,7 @@ If you run into any problems feel free to create an issue. PRs are much apprecia Join the conversation on [the Graph Discord](https://thegraph.com/discord). -Please follow the [Code of Conduct](https://github.com/graphops/graphcast-sdk/blob/main/CODE_OF_CONDUCT.md) for all the communications and at events. Thank you! +Please follow the [Code of Conduct](https://github.com/graphops/graphcast-sdk/blob/dev/code_of_conduct.md) for all the communications and at events. Thank you! ## Commit messages and pull requests @@ -57,52 +57,22 @@ in small logical steps, in one sitting without ever having to touch up something you did earlier in the pull request. (In reality, that means you'll use `git rebase -i` a lot). -Please do not merge main into your branch as you develop your pull -request; instead, rebase your branch on top of the latest main if your +Please do not merge dev into your branch as you develop your pull +request; instead, rebase your branch on top of the latest dev if your pull request branch is long-lived. -We try to keep the hostory of the `main` and `dev` branch linear, and avoid merge -commits. Once your pull request is approved, merge it following these -steps: -``` -git checkout dev -git pull dev -git rebase dev my/branch -git push --force-with-lease -git checkout dev -git merge my/branch -git push -``` - -Allegedly, clicking on the `Rebase and merge` button in the Github UI has -the same effect. +We try to keep the hostory of the `dev` branch linear, and avoid merge +commits. Once your pull request is approved merge it using the `Rebase and merge` button in the Github UI. ## Release process TL;DR ``` -1. Make sure both `dev` and `main` are up-to their respective head -2. Checkout a release branch from `dev` branch - 1. update version in Cargo.toml - 2. run `scripts/release.sh` - 3. After script finishes, push the branch. Squash the commit if there were multiple attempts and commits. -3. Open release PR, set merge target to `dev`. Do not delete the release branch. Rebase and merge. Make sure all tests pass. -4. Repeat step 3 for `main`, delete release branch afterwards. -5. Create Github release with target set to `main`. Generate release notes. +1. Make a new branch from `dev` with a release commit, updating `Cargo.toml` version attribute and `CHANGELOG.md`. +2. Open release PR, set merge target to `dev`. Do not delete the release branch. Rebase and merge. Make sure all tests pass. +3. Tag the release in `dev`: `git tag ` and push the tag: `git push tag ` +4. Run `./scripts/docker-cargo-publish.sh` to publish the new release to `crates.io` ``` -We would like to keep `main` branch for official releases while using `dev` branch as the default upstream branch for features. Therefore ongoing development, feature work, and bug fixes will takes place on the dev branch, and only merge release tag commits to the `main` branch. - To start working on a new feature or bug fix, contributors should create a new branch off of the dev branch. Once the feature or bug fix is complete, a pull request should be created to merge the changes into the dev branch. All changes to the dev branch should be reviewed by at least one other person before merging. - -When it's time to create a new release, we will merge the changes from the dev branch into the `main` branch using a pull request with new version tag (ex. `v0.1.0`). This pull request should be reviewed by at least one project owner before merging. Once the changes are merged into `main`, we will create a new tag for the release and use this tag to generate release notes and create a release in GitHub. To release a new version in crates.io, we update the version in Cargo.toml, utilize the tool [orhun/git-cliff](https://github.com/orhun/git-cliff) to maintain the changelog markdown by simply running the script under `scripts/release.sh` with the new version tag. - -``` -git tag -a vX.X.X -m "vX.X.X" -git push --follow-tags -``` - -It's important to note that all changes to the `main` branch should go through pull requests and be reviewed by at least one project admin. This helps ensure that the `main` branch only contains clean releases and that any issues or bugs are caught before they are released to our users. - -By following this release process, we can keep our repository organized, ensure that our releases are clean and stable, and make it easier for contributors to work on new features and bug fixes. diff --git a/scripts/release.sh b/scripts/release.sh deleted file mode 100755 index 2360cec..0000000 --- a/scripts/release.sh +++ /dev/null @@ -1,21 +0,0 @@ -#!/usr/bin/env bash - -set -e -set -x - -VERSION="v$(cargo metadata --quiet --format-version 1 | jq -r '.packages[] | select(.name == "graphcast-sdk") | .version')" - -if [[ -z "$VERSION" ]]; then - echo "Usage: $0 " - exit 1 -fi - -git-cliff -o CHANGELOG.md - -( - git add CHANGELOG.md Cargo.lock Cargo.toml scripts/release.sh \ - && git commit -m "chore: release $VERSION" -) || true - -# Publish to crates.io -cargo publish