-
Notifications
You must be signed in to change notification settings - Fork 0
リリースの手順を明文化する #74
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.
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
Merged
リリースの手順を明文化する #74
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
0760b3c
📚doc: Add RELEASING.md
negokaz-tis 1b0ec44
📚doc: Add a pull request template for releasing
negokaz-tis fd8eea9
📚doc: Update RELEASING.md
negokaz-tis 49faec5
📚doc: Add a task 'Create a release' to the PR template
negokaz-tis 5e12ac5
📚doc: Remove an image that PR template references
negokaz-tis File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,61 @@ | ||
| <!-- | ||
| PR title format: Release vN.N.N | ||
|
|
||
| Please rewrite the versions in this template before submitting the PR: | ||
| - Current version: X.X.X | ||
| - New version: N.N.N | ||
| --> | ||
|
|
||
| ## ToDo before merging | ||
| - [ ] [Update `README.md`](#update-readmemd) | ||
| - [ ] [Update `CHANGELOG.md`](#update-changelogmd) | ||
| - [ ] [Verify version numbers that need to be updated](#verify-version-numbers-that-need-to-be-updated) | ||
|
|
||
| ### Update `README.md` | ||
| - Update `LernaVersion` to a new version | ||
|
|
||
| ### Update `CHANGELOG.md` | ||
| - Add a section for the new version | ||
| - Update a link for `[Unreleased]` | ||
|
|
||
| ### Verify version numbers that need to be updated | ||
|
|
||
| ```shell | ||
| git grep --fixed-string X.X.X | ||
| ... | ||
| ``` | ||
|
|
||
| ## ToDo after merging | ||
| - [ ] [Push a tag](#push-a-tag) | ||
| - [ ] [Check Maven Central Repository](#check-maven-central-repository) | ||
| - [ ] [Create a release](#create-a-release) | ||
|
|
||
| ### Push a tag | ||
|
|
||
| ```shell | ||
| git tag vN.N.N | ||
| git push origin vN.N.N | ||
| ``` | ||
|
|
||
| ### Check Maven Central Repository | ||
|
|
||
| [Maven Central Repository](https://repo1.maven.org/maven2/com/lerna-stack/) | ||
|
|
||
| **NOTE** | ||
| - They will appear about 10 minutes after publishing on [release workflow](https://github.com/lerna-stack/lerna-app-library/actions/workflows/release.yml) | ||
| - It requires more time to be able to find them with searching (about 2 hours max) | ||
|
|
||
| ### Create a release | ||
|
|
||
| Create a release from the following URL: | ||
|
|
||
| https://github.com/lerna-stack/lerna-app-library/releases/new | ||
|
|
||
| - **Choose a tag**: select the tag you created | ||
| - **Release title**: same as the tag | ||
| - **Describe this release**: | ||
| ```markdown | ||
| See [CHANGELOG.md] for details. | ||
|
|
||
| [CHANGELOG.md]: https://github.com/lerna-stack/lerna-app-library/blob/main/CHANGELOG.md#vNNN---YYYY-MM-DD <!-- write an anchor for the release version --> | ||
| ``` | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| # Releasing | ||
|
|
||
| This document shows how to release a new version. | ||
|
|
||
| ## 1. Create a new branch | ||
|
|
||
| ```shell | ||
| git checkout main | ||
| git pull | ||
| git checkout -b release/vN.N.N # replace N.N.N to a new release version | ||
| ``` | ||
|
|
||
| ## 2. Create a new PR | ||
|
|
||
| Create a new PR with the [`releasing.md` PR Template](./.github/PULL_REQUEST_TEMPLATE/releasing.md) after pushing the branch: | ||
|
|
||
| ```shell | ||
| git push | ||
| ``` | ||
|
|
||
| Ask a maintainer to review the PR after submitting it. |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.