Added some CICD best practices to the documentation #5827
Conversation
|
Thank you for opening this pull request! 🙌 These tips will help get your PR across the finish line:
|
|
@davidmirror-ops @samhita-alla I tried to add the documentation regarding CICD, please have a look at this PR 🙌 |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #5827 +/- ##
===========================================
- Coverage 50.80% 36.82% -13.99%
===========================================
Files 1163 1309 +146
Lines 89206 130938 +41732
===========================================
+ Hits 45325 48217 +2892
- Misses 39881 78537 +38656
- Partials 4000 4184 +184
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
|
I merged the changes (done by recently merged PRs) into my branch, so this PR does not have any merge conflicts 🙌 |
|
@davidmirror-ops The checks have passed, Please have a look at the Documentation and suggest required changes 🙌 |
Signed-off-by: AYUSH SAHU <[email protected]>
|
@samhita-alla @davidmirror-ops I tried to improve the documentation, Please have a look. As this is a documentation change, I believe continuous feedback and improvement can make for a good article 😄 🙌 |
|
|
||
| - **Container Image Specification** : When managing multiple images across tasks within a Flyte workflow, use the `--image` flag during registration to specify which image to use. This avoids hardcoding the image within the task definition, promoting reusability and flexibility in workflows. | ||
|
|
||
| - **Helm and GoReleaser for Packaging and Releasing**: Use Helm for managing Kubernetes package releases and GoReleaser for automating the release of Go applications. These tools streamline the packaging and distribution processes, making the CI/CD pipeline more robust and manageable. These are used in the `helm-release` and `manifest-release` jobs. |
There was a problem hiding this comment.
I think we can remove this one (line 380), we don't expect users to release Go apps with Flyte.
|
|
||
| - **Versioning Strategy** : Determining the version of the build for different types of commits makes them consistent and identifiable. For commits on feature branches, use `<branch-name>-<short-commit-hash>` and for the ones on main branches, use `main-<short-commit-hash>`. Use version numbers for the released (tagged) versions. | ||
|
|
||
| - **Container Image Management** : With Docker or any other CRI-compliant engine, build and push images to maintain traceability and consistency across environments. |
There was a problem hiding this comment.
Also we can remove this one (line 374) as it's pretty generic
Tracking issue
Closes #4685
Why are the changes needed?
The documentation at this page talks about Github Actions with CI/CD and Flyte. But, It can be new to many people to work with CICD process and some extra documentation will be helpful.
What changes were proposed in this pull request?
In the docs/user_guide/flyte_fundamentals/registering_workflows.md file, which can be seen deployed at this page, I added some documentation related to CI/CD best practices near the end of the file.
How was this patch tested?
The Pull Request is about simple Documentation changes.
Check all the applicable boxes
Related PRs
Docs link