-
Notifications
You must be signed in to change notification settings - Fork 1k
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
chore: Update docs with new release workflow #2898
Conversation
Signed-off-by: Kevin Zhang <[email protected]>
Codecov Report
@@ Coverage Diff @@
## master #2898 +/- ##
==========================================
+ Coverage 80.65% 81.20% +0.54%
==========================================
Files 176 183 +7
Lines 15663 17429 +1766
==========================================
+ Hits 12633 14153 +1520
- Misses 3030 3276 +246
Flags with carried forward coverage won't be shown. Click here to find out more.
Continue to review full report at Codecov.
|
docs/project/release-process.md
Outdated
* Make sure that each item is categorised correctly. You will see the following categories: `Breaking changes`, `Implemented enhancements`, `Fixed bugs`, and `Merged pull requests`. Any unlabelled PRs will be found in `Merged pull requests`. It's important to make sure that any `breaking changes`, `enhancements`, or `bug fixes` are pulled up out of `merged pull requests` into the correct category. Housekeeping, tech debt clearing, infra changes, or refactoring do not count as `enhancements`. Only enhancements a user benefits from should be listed in that category. | ||
* Make sure that the "Full Change log" link is actually comparing the correct tags (normally your released version against the previously version). | ||
* Make sure that release notes and breaking changes are present. | ||
1. Merge upstream master changes into your fork. |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
fixed
Signed-off-by: Kevin Zhang <[email protected]>
Signed-off-by: Kevin Zhang <[email protected]>
Signed-off-by: Kevin Zhang <[email protected]>
Signed-off-by: Kevin Zhang <[email protected]>
Signed-off-by: Kevin Zhang <[email protected]>
Signed-off-by: Kevin Zhang <[email protected]>
Signed-off-by: Kevin Zhang <[email protected]>
Signed-off-by: Kevin Zhang <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
/lgtm
Signed-off-by: Kevin Zhang <[email protected]>
Signed-off-by: Kevin Zhang <[email protected]>
Signed-off-by: Kevin Zhang <[email protected]>
Signed-off-by: Kevin Zhang <[email protected]>
docs/project/release-process.md
Outdated
1. Merge upstream master changes into your **fork**. Make sure you are running the workflow off of your fork! | ||
2. Create a tag manually for the release on your fork. For example, if you are doing a release for version 0.22.0, create a tag by doing the following. | ||
- Checkout master branch and run `git tag v0.22.0`. | ||
- Run `git push --tags` to push the tag to remote. |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fixed
docs/project/release-process.md
Outdated
- Run `git push --tags` to push the tag to remote. | ||
3. Access the `Actions` tab on your github UI on your fork and click the `build_wheels` action. | ||
4. Look for the header `This workflow has a workflow_dispatch event trigger` and click `Run Workflow` on the right. | ||
5. Run the workflow off of the tag you just created(`v0.22.0` in this case) and verify that the workflow worked. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What kind of verification?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
clarified.
docs/project/release-process.md
Outdated
4. Push tags to your origin branch with `git push origin <tag>`. | ||
5. Kick off `build_wheels` workflow in the same way as is detailed in the last section on of the patch release tag. | ||
|
||
### Release |
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Clarified
docs/project/release-process.md
Outdated
2. Create a tag manually for the release on your fork. For example, if you are doing a release for version 0.22.0, create a tag by doing the following. | ||
- Checkout master branch and run `git tag v0.22.0`. | ||
- Run `git push --tags` to push the tag to remote. | ||
3. Access the `Actions` tab on your github UI on your fork and click the `build_wheels` action. |
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fixed.
Signed-off-by: Kevin Zhang <[email protected]>
@@ -430,7 +430,7 @@ def build_extension(self, ext: Extension): | |||
destination = os.path.dirname(os.path.abspath(self.get_ext_fullpath(ext.name))) | |||
subprocess.check_call(["go", "install", "golang.org/x/tools/cmd/goimports"], | |||
env={"PATH": bin_path, **go_env}) | |||
subprocess.check_call(["go", "get", "github.com/go-python/[email protected].0"], | |||
subprocess.check_call(["go", "get", "github.com/go-python/[email protected].4"], |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Have we updated the build process to pass in the new flags? If not, this change is incomplete (and should be in a different PR anyway).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yup
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
/lgtm
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: felixwang9817, kevjumba The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
* Update docs Signed-off-by: Kevin Zhang <[email protected]> * Fix Signed-off-by: Kevin Zhang <[email protected]> * Fix Signed-off-by: Kevin Zhang <[email protected]> * Fix Signed-off-by: Kevin Zhang <[email protected]> * Fix Signed-off-by: Kevin Zhang <[email protected]> * Fix Signed-off-by: Kevin Zhang <[email protected]> * Fix Signed-off-by: Kevin Zhang <[email protected]> * Fix Signed-off-by: Kevin Zhang <[email protected]> * Fix Signed-off-by: Kevin Zhang <[email protected]> * Fix Signed-off-by: Kevin Zhang <[email protected]> * Fix Signed-off-by: Kevin Zhang <[email protected]> * Fix Signed-off-by: Kevin Zhang <[email protected]> * Fix Signed-off-by: Kevin Zhang <[email protected]> * Fix Signed-off-by: Kevin Zhang <[email protected]>
* Update docs Signed-off-by: Kevin Zhang <[email protected]> * Fix Signed-off-by: Kevin Zhang <[email protected]> * Fix Signed-off-by: Kevin Zhang <[email protected]> * Fix Signed-off-by: Kevin Zhang <[email protected]> * Fix Signed-off-by: Kevin Zhang <[email protected]> * Fix Signed-off-by: Kevin Zhang <[email protected]> * Fix Signed-off-by: Kevin Zhang <[email protected]> * Fix Signed-off-by: Kevin Zhang <[email protected]> * Fix Signed-off-by: Kevin Zhang <[email protected]> * Fix Signed-off-by: Kevin Zhang <[email protected]> * Fix Signed-off-by: Kevin Zhang <[email protected]> * Fix Signed-off-by: Kevin Zhang <[email protected]> * Fix Signed-off-by: Kevin Zhang <[email protected]> * Fix Signed-off-by: Kevin Zhang <[email protected]>
Signed-off-by: Kevin Zhang [email protected]
What this PR does / why we need it:
Which issue(s) this PR fixes:
Fixes #