Skip to content

chore: Update docs with new release workflow #2898

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
kevjumba merged 14 commits into from
Jul 12, 2022
Merged

chore: Update docs with new release workflow #2898

Changes from 1 commit
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
ecf99f0
Update docs
kevjumba Jun 30, 2022
54d9fbe
Fix
kevjumba Jun 30, 2022
00651be
Fix
kevjumba Jun 30, 2022
748213b
Fix
kevjumba Jun 30, 2022
136258d
Fix
kevjumba Jul 1, 2022
b779e51
Fix
kevjumba Jul 1, 2022
1820ae9
Fix
kevjumba Jul 1, 2022
cdb5005
Fix
kevjumba Jul 1, 2022
4f1c410
Fix
kevjumba Jul 1, 2022
ae4bc72
Fix
kevjumba Jul 1, 2022
256bc63
Fix
kevjumba Jul 1, 2022
a8ca125
Fix
kevjumba Jul 1, 2022
8bc5b1c
Fix
kevjumba Jul 1, 2022
bb2e4c7
Fix
kevjumba Jul 5, 2022
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
Prev Previous commit
Next Next commit
Fix 
Signed-off-by: Kevin Zhang <kzhang@tecton.ai>
  • Loading branch information
@kevjumba
kevjumba committed Jun 30, 2022
commit 00651be3960a10c61912dc05cd7d0f9875a98bc4
8 changes: 4 additions & 4 deletions docs/project/release-process.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,15 @@ For Feast maintainers, these are the concrete steps for making a new release.

1. Merge upstream master changes into your fork.
Copy link
Copy Markdown
Member

@achals achals Jun 30, 2022

Choose a reason for hiding this comment

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

Maybe this should have two sections, one on how to run the build_wheels workflow on personal forks with a manually applied tag to verify wheels are being created correctly, and a second on how to run the release workflow using your personal access token on master in the feast repo.

Copy link
Copy Markdown
Collaborator Author

@kevjumba kevjumba Jun 30, 2022

Choose a reason for hiding this comment

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

fixed

2. Create a tag manually for the release on your fork. For example, if your release is on version 0.22.0, create a tag by doing the following.
Comment thread
felixwang9817 marked this conversation as resolved.
Outdated
- Checkout master branch and run `git tag v0.22.0`.
- Run `git push --tags` to push the tag to remote.
- Checkout master branch and run `git tag v0.22.0`.
- Run `git push --tags` to push the tag to remote.
Copy link
Copy Markdown
Member

@achals achals Jul 2, 2022

Choose a reason for hiding this comment

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

To push the tag to your forks master branch.

Copy link
Copy Markdown
Collaborator Author

@kevjumba kevjumba Jul 5, 2022

Choose a reason for hiding this comment

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

Fixed

3. Access the `Actions` tab on your github UI on your fork and click the `build_wheels` action.
Copy link
Copy Markdown
Member

@achals achals Jul 2, 2022

Choose a reason for hiding this comment

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

What does this workflow do? What does it build? What combinations?

Copy link
Copy Markdown
Collaborator Author

@kevjumba kevjumba Jul 5, 2022

Choose a reason for hiding this comment

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

Fixed.

4. Look for the header `This workflow has a workflow_dispatch event trigger.` and click `Run Workflow` on the right.
5. Run the branch off of the tag you just created(`v0.22.0`) in this case and verify that the workflow worked.
5. Run the branch off of the tag you just created(`v0.22.0` in this case) and verify that the workflow worked.
Comment thread
felixwang9817 marked this conversation as resolved.
Outdated
Comment thread
felixwang9817 marked this conversation as resolved.
Outdated

### Release
Copy link
Copy Markdown
Member

@achals achals Jul 2, 2022

Choose a reason for hiding this comment

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

What stuff does this workflow do? Python release? Java release? UI release? Helm charts? Docker images?

Copy link
Copy Markdown
Collaborator Author

@kevjumba kevjumba Jul 5, 2022

Choose a reason for hiding this comment

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

Clarified

6. 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.
- The personal access token should have all of the permissions under the `repo` checkbox.
- The personal access token should have all of the permissions under the `repo` checkbox.
7. Access the `Actions` tab on the main `feast-dev/feast` repo and find the `release` action.
8. Look for the header `This workflow has a workflow_dispatch event trigger.` again and click `Run Workflow` on the right.
9. Try the dry run first with your personal access token. If this succeeds, uncheck `Dry Run` and run the release workflow.
Expand Down