Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Minor documentation update to add info about maven automated workflow #795

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
jainr merged 28 commits into from
Oct 31, 2022
Merged

Minor documentation update to add info about maven automated workflow #795

Changes from all commits
Commits
Show all changes
28 commits
Select commit Hold shift + click to select a range
89c9bfd
Adding DevSkim linter to Github actions
jainr Sep 9, 2022
1c8c13d
Merge pull request #1 from jainr/rijai/devskim
jainr Sep 9, 2022
bea6618
Update docker-publish.yml
jainr Sep 16, 2022
0963b5e
Update docker-publish.yml
jainr Sep 16, 2022
68c5490
Update docker-publish.yml
jainr Sep 16, 2022
758a521
Update docker-publish.yml
jainr Sep 16, 2022
5dad67c
Update docker-publish.yml
jainr Sep 16, 2022
101a4c2
Update docker-publish.yml
jainr Sep 16, 2022
0a8ddea
Update docker-publish.yml
jainr Sep 16, 2022
b663baf
Update docker-publish.yml
jainr Sep 16, 2022
6d9d71c
Merge branch 'main' of https://github.com/feathr-ai/feathr into main
jainr Oct 3, 2022
3b8a620
Merge conflicts
jainr Oct 3, 2022
7151922
Merge branch 'main' of https://github.com/feathr-ai/feathr into rijai…
jainr Oct 12, 2022
9143e39
Removing devskim file
jainr Oct 12, 2022
6b34dbe
Restructuring the Prod Reco sample
jainr Oct 12, 2022
ce4ed50
Adjusting headings
jainr Oct 12, 2022
4aadce4
Minor changes
jainr Oct 12, 2022
00587c6
Removing changes to docker publish file
jainr Oct 12, 2022
6419344
Addressing PR comments, moving Product recommendation notebook sample…
jainr Oct 19, 2022
42209f1
Addressing PR comments
jainr Oct 19, 2022
5077069
Fixing images
jainr Oct 19, 2022
ea28952
Removing the need to pass email id as we could directly compute objec…
jainr Oct 20, 2022
984b2d2
Merge branch 'main' of https://github.com/feathr-ai/feathr into rijai…
jainr Oct 27, 2022
99d480d
Fixing typos
jainr Oct 27, 2022
8b49986
Combining product_reco and product_reco_advanced into one notebook
jainr Oct 28, 2022
8a1563e
Updating release guide with maven automated workflow information
jainr Oct 28, 2022
c7fc0c7
Merge branch 'main' of https://github.com/feathr-ai/feathr into rijai…
jainr Oct 29, 2022
cf20924
Removing notebook changes in this PR
jainr Oct 29, 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
11 changes: 5 additions & 6 deletions docs/dev_guide/feathr_overall_release_guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,25 +47,24 @@ Our goal is to automate the release process as much as possible. So far, we have

**Triggers** - branch with name pattern "releases/*"

1. Automated Maven workflow - Coming soon.
1. Automated [workflow](https://github.com/feathr-ai/feathr/blob/main/.github/workflows/publish-to-maven.yml) for publishing the jar to [maven/sonatype repository](https://oss.sonatype.org/).

**PLEASE NOTE: To trigger the above workflows as part of release, create a new branch with pattern releases/v0.x.0**. See past release branches [here](https://github.com/feathr-ai/feathr/branches/all?query=releases).


## Release Maven

See [Developer Guide for publishing to maven](publish_to_maven.md)

## Upload Feathr Jar

Run the command to generate the Java jar. After the jar is generated, please upload to [Azure storage](https://ms.portal.azure.com/#view/Microsoft_Azure_Storage/ContainerMenuBlade/~/overview/storageAccountId/%2Fsubscriptions%2Fa6c2a7cc-d67e-4a1a-b765-983f08c0423a%2FresourceGroups%2Fazurefeathrintegration%2Fproviders%2FMicrosoft.Storage%2FstorageAccounts%2Fazurefeathrstorage/path/public/etag/%220x8D9E6F64D62D599%22/defaultEncryptionScope/%24account-encryption-key/denyEncryptionScopeOverride//defaultId//publicAccessVal/Container) for faster access.

## Release PyPi
The automated workflow should take care of this, you can check under [actions](https://github.com/feathr-ai/feathr/actions/workflows/publish-to-pypi.yml) to see the triggered run and results. For manual steps, see [Python Package Release Note](https://feathr-ai.github.io/feathr/dev_guide/python_package_release.html)
The automated workflow should take care of this, you can check under [actions](https://github.com/feathr-ai/feathr/actions/workflows/publish-to-pypi.yml) to see the triggered run and results. For manual steps, see [Python Package Release Guide](https://feathr-ai.github.io/feathr/dev_guide/python_package_release.html)

## Updating docker image for API and Registry
The automated workflow should take care of this as well, you can check under [actions](https://github.com/feathr-ai/feathr/actions/workflows/docker-publish.yml) to see the triggered run and results. For manual steps, see [Feathr Registry docker image](https://feathr-ai.github.io/feathr/dev_guide/build-and-push-feathr-registry-docker-image.html)

## Release Maven
The automated workflow should take of this too, you can check under [actions](https://github.com/feathr-ai/feathr/blob/main/.github/workflows/publish-to-maven.yml) to see the triggered run and results. For manual steps, see [Feathr Developer Guide for publishing to maven](https://feathr-ai.github.io/feathr/dev_guide/publish_to_maven.html)

## Testing
Run one of the sample [notebook](https://github.com/feathr-ai/feathr/blob/main/docs/samples/azure_synapse/product_recommendation_demo.ipynb) as it uses the latest package from Maven and PyPi.

Expand Down