-
Notifications
You must be signed in to change notification settings - Fork 21
docs: add release process #239
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
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
d7721b3
docs: add release process
eunjae-lee 5dfaf16
Apply suggestions from code review
eunjae-lee b3d7607
docs: apply feedback
eunjae-lee 7c13462
docs: remove submodule mention
eunjae-lee 9916bab
Merge branch 'main' into docs/contrib
eunjae-lee 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,3 @@ | ||
# See ./website/docs/releaseProcess.md for more information. | ||
|
||
GITHUB_TOKEN= |
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
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,42 @@ | ||
--- | ||
title: Release process | ||
--- | ||
|
||
# Release process | ||
|
||
The most of the release process is automated. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I don't think we need to state it |
||
|
||
## Part 1 | ||
|
||
You need `GITHUB_TOKEN` in your `.env` file. You can generate one from [Personal access token](https://github.com/settings/tokens/new) with `Repo (Full control of private repositories)` scope. | ||
eunjae-lee marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
``` | ||
GITHUB_TOKEN=<YOUR-PERSONAL-ACCESS-TOKEN> | ||
``` | ||
|
||
Once it's prepared, you can run | ||
eunjae-lee marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
```bash | ||
yarn release | ||
``` | ||
|
||
It will create [a release issue](https://github.com/algolia/api-clients-automation/issues/220). | ||
|
||
## Part 2 | ||
|
||
You need to review the release issue, in two parts: | ||
|
||
1. version changes | ||
2. CHANGELOGs | ||
|
||
Any changes applied in the issue will be taken into account by the release process. | ||
|
||
You can click "Approved" to approve the release, and close it, which will trigger the Part 3. | ||
eunjae-lee marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
## Part 3 | ||
|
||
The [GitHub action release](https://github.com/algolia/api-clients-automation/blob/main/.github/workflows/process-release.yml) is triggered. It generates clients and push changes to the submodules. All the submodules will have new commits on their base branch (`next`). | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. We don't use submodules anymore |
||
|
||
This Part 3 runs conditionally according to what has been done in Part 2. Under "Version Changes" section of the release issue, if a language is checked, this Part 3 will creates a commit like `chore: release v<NEXT-VERSION>` in the submodule. If it is not checked, it will create a commit like `chore: update repo <DATE-STAMP>`. | ||
shortcuts marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
Each language repository should have their own release process, and should run only when the latest commit starts with `chore: release`. By doing so, we have a way to just update the repository, for example READMEs, without having to release. |
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 |
---|---|---|
|
@@ -20,6 +20,7 @@ const sidebars = { | |
'addNewClient', | ||
'addNewLanguage', | ||
'pullRequest', | ||
'releaseProcess', | ||
], | ||
}, | ||
{ | ||
|
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.