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

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

Murdock9803
Copy link
Contributor

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.35%. Comparing base (197ae13) to head (962ccfa).

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #5827      +/-   ##
==========================================
+ Coverage   34.48%   36.35%   +1.86%     
==========================================
  Files        1138     1304     +166     
  Lines      102742   110148    +7406     
==========================================
+ Hits        35434    40043    +4609     
- Misses      63634    65938    +2304     
- Partials     3674     4167     +493     
Flag Coverage Δ
unittests-datacatalog 51.37% <ø> (ø)
unittests-flyteadmin 55.60% <ø> (ø)
unittests-flytecopilot 12.17% <ø> (ø)
unittests-flytectl 62.21% <ø> (?)
unittests-flyteidl 7.17% <ø> (ø)
unittests-flyteplugins 53.35% <ø> (ø)
unittests-flytepropeller 42.02% <ø> (ø)
unittests-flytestdlib 55.37% <ø> (+0.02%) ⬆️

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.

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Docs] document ci/cd best practices
1 participant