Skip to content
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

Merged
merged 16 commits into from
Oct 30, 2024

Conversation

Murdock9803
Copy link
Contributor

@Murdock9803 Murdock9803 commented Oct 9, 2024

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

  • I updated the documentation accordingly.
  • All new and existing tests passed.
  • All commits are signed-off.

Related PRs

Docs link

Copy link

welcome bot commented Oct 9, 2024

Thank you for opening this pull request! 🙌

These tips will help get your PR across the finish line:

  • Most of the repos have a PR template; if not, fill it out to the best of your knowledge.
  • Sign off your commits (Reference: DCO Guide).

@Murdock9803
Copy link
Contributor Author

@davidmirror-ops @samhita-alla I tried to add the documentation regarding CICD, please have a look at this PR 🙌

Copy link

codecov bot commented Oct 9, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 36.97%. Comparing base (e0da46b) to head (6df40f0).
Report is 2 commits behind head on master.

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     
Flag Coverage Δ
unittests-datacatalog 51.58% <ø> (ø)
unittests-flyteadmin 54.08% <ø> (-0.03%) ⬇️
unittests-flytecopilot ?
unittests-flytectl 62.40% <ø> (?)
unittests-flyteidl 6.92% <ø> (ø)
unittests-flyteplugins 53.64% <ø> (ø)
unittests-flytepropeller 43.02% <ø> (ø)
unittests-flytestdlib 55.41% <ø> (+0.01%) ⬆️

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

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@davidmirror-ops davidmirror-ops self-requested a review October 9, 2024 22:28
@Murdock9803
Copy link
Contributor Author

I merged the changes (done by recently merged PRs) into my branch, so this PR does not have any merge conflicts 🙌

@Murdock9803
Copy link
Contributor Author

@davidmirror-ops The checks have passed, Please have a look at the Documentation and suggest required changes 🙌

@Murdock9803
Copy link
Contributor Author

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

Copy link
Contributor

@davidmirror-ops davidmirror-ops left a 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!

@Murdock9803
Copy link
Contributor Author

@davidmirror-ops I removed the unnecessary lines, please suggest further changes If any 🙌
Should I add more info about some particular topics ?

Copy link
Contributor

@davidmirror-ops davidmirror-ops left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you

@Murdock9803
Copy link
Contributor Author

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

@davidmirror-ops davidmirror-ops merged commit 2b0af2b into flyteorg:master Oct 30, 2024
51 checks passed
@Murdock9803 Murdock9803 deleted the cicd-doc-update branch October 30, 2024 23:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Docs] document ci/cd best practices
3 participants