chore: Update docs with new release workflow#2898

Merged

kevjumba merged 14 commits intofeast-dev:masterfrom

Jul 12, 2022

Collaborator

kevjumba commented Jun 30, 2022

Signed-off-by: Kevin Zhang [email protected]

What this PR does / why we need it:

Which issue(s) this PR fixes:

Fixes #


          Update docs

ecf99f0

Signed-off-by: Kevin Zhang <[email protected]>

kevjumba added the area/documentation label

feast-ci-bot added approved size/M labels

codecov-commenter commented Jun 30, 2022 •

edited

Loading

Codecov Report

Merging #2898 (bb2e4c7) into master (8abc2ef) will increase coverage by 0.54%.
The diff coverage is 0.00%.

@@            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

Flag	Coverage Δ
integrationtests	`72.50% <0.00%> (+1.62%)`	⬆️
unittests	`59.05% <0.00%> (-0.30%)`	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
setup.py	`0.00% <0.00%> (ø)`
.../integration/online_store/test_universal_online.py	`76.52% <0.00%> (-14.72%)`	⬇️
sdk/python/tests/utils/online_read_write_test.py	`93.54% <0.00%> (-6.46%)`	⬇️
...on/tests/integration/registration/test_registry.py	`89.09% <0.00%> (-5.89%)`	⬇️
sdk/python/feast/infra/provider.py	`82.95% <0.00%> (-4.93%)`	⬇️
sdk/python/feast/infra/utils/snowflake_utils.py	`80.51% <0.00%> (-4.32%)`	⬇️
sdk/python/feast/infra/passthrough_provider.py	`96.41% <0.00%> (-3.59%)`	⬇️
.../integration/online_store/test_online_retrieval.py	`96.84% <0.00%> (-3.16%)`	⬇️
...python/feast/infra/offline_stores/offline_store.py	`83.47% <0.00%> (-2.55%)`	⬇️
sdk/python/feast/infra/online_stores/datastore.py	`87.96% <0.00%> (-1.39%)`	⬇️
... and 28 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 8abc2ef...bb2e4c7. Read the comment docs.

achals reviewed

View reviewed changes

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.
+. Merge upstream master changes into your fork.

Member

achals Jun 30, 2022

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.

Collaborator Author

kevjumba Jun 30, 2022

fixed

kevjumba added 3 commits

June 30, 2022 16:13

Fix

54d9fbe

Signed-off-by: Kevin Zhang <[email protected]>

Fix

00651be

Signed-off-by: Kevin Zhang <[email protected]>

Fix

748213b

Signed-off-by: Kevin Zhang <[email protected]>

felixwang9817 reviewed

View reviewed changes

docs/project/release-process.md Outdated Show resolved Hide resolved

felixwang9817 reviewed

View reviewed changes

docs/project/release-process.md Outdated Show resolved Hide resolved

Fix

136258d

Signed-off-by: Kevin Zhang <[email protected]>

felixwang9817 reviewed

View reviewed changes

docs/project/release-process.md Outdated Show resolved Hide resolved

Fix

b779e51

Signed-off-by: Kevin Zhang <[email protected]>

felixwang9817 reviewed

View reviewed changes

docs/project/release-process.md Outdated Show resolved Hide resolved

felixwang9817 reviewed

View reviewed changes

docs/project/release-process.md Outdated Show resolved Hide resolved

kevjumba added 2 commits

July 1, 2022 10:24

Fix

1820ae9

Signed-off-by: Kevin Zhang <[email protected]>

Fix

cdb5005

Signed-off-by: Kevin Zhang <[email protected]>

felixwang9817 reviewed

View reviewed changes

docs/project/release-process.md Outdated Show resolved Hide resolved

felixwang9817 changed the title ~~chore: Update docs with new release workflow.~~ chore: Update docs with new release workflow

Fix

4f1c410

Signed-off-by: Kevin Zhang <[email protected]>

felixwang9817 approved these changes

View reviewed changes

Collaborator

felixwang9817 left a comment

/lgtm

feast-ci-bot assigned felixwang9817

feast-ci-bot added the lgtm label

Fix

ae4bc72

Signed-off-by: Kevin Zhang <[email protected]>

feast-ci-bot removed the lgtm label

kevjumba added 3 commits

July 1, 2022 12:16

Fix

256bc63

Signed-off-by: Kevin Zhang <[email protected]>

Fix

a8ca125

Signed-off-by: Kevin Zhang <[email protected]>

Fix

8bc5b1c

Signed-off-by: Kevin Zhang <[email protected]>

achals reviewed

View reviewed changes

docs/project/release-process.md Outdated

+. Merge upstream master changes into your **fork**. Make sure you are running the workflow off of your fork!
+. 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.

Member

achals Jul 2, 2022

To push the tag to your forks master branch.

Collaborator Author

kevjumba Jul 5, 2022

Fixed

docs/project/release-process.md Outdated

+                 - Run `git push --tags` to push the tag to remote.
+. Access the `Actions` tab on your github UI on your fork and click the `build_wheels` action.
+. Look for the header `This workflow has a workflow_dispatch event trigger` and click `Run Workflow` on the right.
+. Run the workflow off of the tag you just created(`v0.22.0` in this case) and verify that the workflow worked.

Member

achals Jul 2, 2022

What kind of verification?

Collaborator Author

kevjumba Jul 5, 2022

clarified.

docs/project/release-process.md Outdated

+. Push tags to your origin branch with `git push origin <tag>`.
+. Kick off `build_wheels` workflow in the same way as is detailed in the last section on of the patch release tag.
+              ### Release

Member

achals Jul 2, 2022

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

Collaborator Author

kevjumba Jul 5, 2022

Clarified

docs/project/release-process.md Outdated

+. 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.
+. Access the `Actions` tab on your github UI on your fork and click the `build_wheels` action.

Member

achals Jul 2, 2022

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

Collaborator Author

kevjumba Jul 5, 2022

Fixed.

Fix

bb2e4c7

Signed-off-by: Kevin Zhang <[email protected]>

achals requested changes

View reviewed changes

setup.py

                       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"],

Member

achals Jul 6, 2022

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).

Collaborator Author

kevjumba Jul 11, 2022

yup

felixwang9817 approved these changes

View reviewed changes

Collaborator

felixwang9817 left a comment

/lgtm

feast-ci-bot added the lgtm label

Collaborator

feast-ci-bot commented Jul 11, 2022

[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

Details

Needs approval from an approver in each of these files:

~~OWNERS~~ [felixwang9817,kevjumba]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

kevjumba merged commit 9fc81a2 into feast-dev:master

adchia pushed a commit that referenced this pull request


          chore: Update docs with new release workflow (#2898)

ad68ac0

* 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]>

kevjumba added a commit that referenced this pull request


          chore: Update docs with new release workflow (#2898)

3650c4a

* 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]>

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved area/documentation lgtm size/M