From 65633258b7a2a3bd21152fb76f78c649fcc25315 Mon Sep 17 00:00:00 2001 From: Julien Poissonnier Date: Thu, 12 Dec 2024 12:03:06 +0100 Subject: [PATCH 1/3] Add release instructions to CONTRIBUTING.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit I always have to think way too hard about how we do this, and look at old PRs and shell history. Let’s document this! --- CONTRIBUTING.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b5e3c399b40..da0eff468f0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -149,3 +149,15 @@ If you want to talk with other folks in the Pulumi community (including members of the Pulumi team) come hang out in the `#contribute` channel on the [Pulumi Community Slack](https://slack.pulumi.com/). + +## Release Process + +To release a new version of `pulumi-java`, create a new pull request that +updates [CHANGELOG.md](./CHANGELOG.md) and [CHANGLOG_PENDING.md](./CHANGLOG_PENDING.md). + +After the pull request is merged, push the release tags to the `main` branch by +running the [`release.sh`](./scripts/release.sh) script: + +```shell +./scripts/release.sh v0.20.0 +``` From ca2e4b442687f6e06559553f8d2d19b17b677a2d Mon Sep 17 00:00:00 2001 From: Julien Poissonnier Date: Thu, 12 Dec 2024 14:50:00 +0100 Subject: [PATCH 2/3] update instructions --- CONTRIBUTING.md | 24 +++++++++++++++++------- 1 file changed, 17 insertions(+), 7 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index da0eff468f0..f1406f01937 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -152,12 +152,22 @@ If you want to talk with other folks in the Pulumi community ## Release Process -To release a new version of `pulumi-java`, create a new pull request that -updates [CHANGELOG.md](./CHANGELOG.md) and [CHANGLOG_PENDING.md](./CHANGLOG_PENDING.md). +To release a new version of `pulumi-java`, follow these steps: -After the pull request is merged, push the release tags to the `main` branch by -running the [`release.sh`](./scripts/release.sh) script: +1. Create a new pull request that updates [CHANGELOG.md](./CHANGELOG.md) with + the pending changes from [CHANGLOG_PENDING.md](./CHANGLOG_PENDING.md). Do *not* + remove the pending changes from [CHANGLOG_PENDING.md](./CHANGLOG_PENDING.md) + yet. Merge the PR. -```shell -./scripts/release.sh v0.20.0 -``` +2. After the pull request is merged, push the release tags to the `main` branch + by running the [`release.sh`](./scripts/release.sh) script. Make sure you have + updated your local checkout of `origin/main` first. + + ```shell + git checkout main + git pull origin main + ./scripts/release.sh v0.20.0 + ``` + +3. Create a new pull request that emptries the pending changelog in + [CHANGELOG_PENDING.md](./CHANGELOG_PENDING.md). \ No newline at end of file From 26a3cf17c47882423abead16bca54764f82fa78d Mon Sep 17 00:00:00 2001 From: Julien Poissonnier Date: Thu, 12 Dec 2024 14:51:23 +0100 Subject: [PATCH 3/3] typozz --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f1406f01937..dc87f3761bb 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -169,5 +169,5 @@ To release a new version of `pulumi-java`, follow these steps: ./scripts/release.sh v0.20.0 ``` -3. Create a new pull request that emptries the pending changelog in - [CHANGELOG_PENDING.md](./CHANGELOG_PENDING.md). \ No newline at end of file +3. Create a new pull request that empties the pending changelog in + [CHANGELOG_PENDING.md](./CHANGELOG_PENDING.md) and merge it. \ No newline at end of file