Skip to content

Add RC Release Procedure #4749

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
khanhtc1202 merged 1 commit into from
Jan 15, 2024
Merged

Add RC Release Procedure #4749

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 32 additions & 0 deletions RELEASES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,3 +83,35 @@ A bugfix for a functional issue (not a data loss or security issue) that only af
- Before cutting a new release, wait for all jobs in GitHub Actions to pass on the release branch.

- Create a tagged release from the release branch `release-vX.Y.x`. The release should start with "v" and be followed by the version number.

## RC Release
1. Move on to [Releases > Draft a New Release](https://github.com/pipe-cd/pipecd/releases/new).
2. Set values as below:
1. `Choose a tag`: Create a new tag `vX.Y.Z-rcN`
2. `Target`(branch): `master`
3. `Release title`: `Release vX.Y.Z-rcN`
4. Body area
1. Copy from the previous rc-release note.
2. Modify the version of `> Note: This is a candidate release of vX.Y.Z.` if needed.
3. Modify the version of `## Changes since`.
4. List Changes:
1. Extract commits to include by the below commands.

```zsh
$ PREVIOUS_TAG=v0.46.0-rc1 # Set the previous release tag
$ git log $PREVIOUS_TAG..HEAD --oneline | awk '{$1=""; print substr($0, 2)}'
```

output(from newer to older):

```
Add reference to the blog that shows how to install control plane on ECS (#4746)
Update copyright (#4745)
...
Add docs for SCRIPT_RUN stage (#4734)
```

2. Classify the changes into 'Notable Changes' and 'Internal Changes'.
Copy link
Member

@ffjlabo ffjlabo Jan 12, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[nit] How about adding the explanation for 'Notable Changes' and 'Internal Changes' 👀

  • Notable Changes
    • Changes that should notify users (i.g., new features, breaking changes, etc.)
  • Internal Changes
    • Changes that don't affect the functions

@khanhtc1202 This is my understanding. Are you aware of it? 👀

Copy link
Member

@khanhtc1202 khanhtc1202 Jan 12, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think those words have mean by itself. But if you want to add definition for those, should be added at other level in this release note file. Say, place of defining versions semantic or such 👀

Copy link
Member

@ffjlabo ffjlabo Jan 12, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think those words have mean by itself.

@khanhtc1202
Oh I see, I got it. That's right (checked with translator🙏 )
I agree with it 👍 We don't need do that. Thanks!

Copy link
Member

@ffjlabo ffjlabo Jan 12, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@t-kikuc Plz forget to the nit comment 🙏

3. Write them to the body area.
5. **Select `Set as a pre-release`**, not `Set as the latest release`.
3. Push `Publish Release`.