Skip to content

Commit 240a3c9

Browse files
committed
Fix release
Signed-off-by: Kevin Zhang <[email protected]>
1 parent 795db03 commit 240a3c9

1 file changed

Lines changed: 8 additions & 6 deletions

File tree

‎docs/project/release-process.md‎

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22,31 +22,33 @@ For Feast maintainers, these are the concrete steps for making a new release.
2222

2323
### Release for Python and Java SDK
2424
1. Generate a [Personal Access Token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token) or retrieve your saved personal access token.
25-
- The personal access token should have all of the permissions under the `repo` checkbox.
25+
* The personal access token should have all of the permissions under the `repo` checkbox.
2626
2. Access the `Actions` tab on the main `feast-dev/feast` repo and find the `release` action.
2727
3. Look for the header `This workflow has a workflow_dispatch event trigger` again and click `Run Workflow` on the right.
28+
* If you are making a minor or major release, you should run it off of the master branch.
29+
* If you are making a patch release, run it off of the corresponding minor release branch.
2830
4. Try the dry run first with your personal access token. If this succeeds, uncheck `Dry Run` and run the release workflow.
2931
5. All of the jobs should succeed besides the UI job which needs to be released separately. Ping a maintainer on Slack to run the UI release manually.
3032
6. Try to install the feast release in your local environment and test out the `feast init` -> `feast apply` workflow to verify as a sanity check that the release worked correctly.
3133

3234
### (for minor releases) Post-release steps
3335
1. Create a new branch based on master (i.e. v0.22-branch) and push to the main Feast repo. This will be where cherry-picks go for future patch releases and where documentation will point.
34-
2. Write a summary of the release in the GitHub release
36+
2. Write a summary of the release in the GitHub release
3537
1. By default, Semantic Release will pull in messages from commits (features vs fixes, etc). But this is hard to digest still, so it helps to have a high level overview.
3638

3739
### Update documentation
3840

39-
In the Feast Gitbook (ask [Danny Chiao](https://tectonfeast.slack.com/team/U029405HFEU) in Slack for access):
41+
In the Feast Gitbook (ask [Danny Chiao](https://tectonfeast.slack.com/team/U029405HFEU) in Slack for access):
4042
1. Create a new space within the Feast collection
41-
2. Go to the overflow menu on the top -> Synchronize with Git
43+
2. Go to the overflow menu on the top -> Synchronize with Git
4244
1. Specify GitHub as the provider
43-
45+
4446
![](new_branch_part_1.png)
4547
2. Configure to point to the new release branch
4648

4749
![](new_branch_part_2.png)
4850
3. Publish the new page for this branch as part of the collection
49-
51+
5052
![](new_branch_part_3.png)
5153
4. Go back to the main Feast collection and go to the overflow menu -> "Customize collection"
5254

0 commit comments

Comments
 (0)