-
Notifications
You must be signed in to change notification settings - Fork 661
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
Added some CICD best practices to the documentation #5827
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 35.00% 36.97% +1.96%
==========================================
Files 1143 1301 +158
Lines 122197 130312 +8115
==========================================
+ Hits 42777 48182 +5405
- Misses 75723 77953 +2230
- Partials 3697 4177 +480
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 😄 🙌 |
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.
Left some comments. Thanks!
Signed-off-by: AYUSH SAHU <[email protected]>
Signed-off-by: AYUSH SAHU <[email protected]>
@davidmirror-ops I removed the unnecessary lines, please suggest further changes If any 🙌 |
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.
Thank you
@davidmirror-ops Thanks for approving the changes ❤️. I have pulled in the latest changes from the main branch into my branch so its up to date 🙌 |
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