-
-
Notifications
You must be signed in to change notification settings - Fork 278
ci(workflow): move 'generate_cli_screenshots' steps to 'docspublish' #1126
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
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #1126 +/- ##
==========================================
+ Coverage 97.33% 97.54% +0.20%
==========================================
Files 42 55 +13
Lines 2104 2486 +382
==========================================
+ Hits 2048 2425 +377
- Misses 56 61 +5
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
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.
Mostly good. Left a minor nitpick.
Since the purpose is to updated the CLI screenshots on Github Pages, combining this two workflows makes sense.
Since the purpose is to updated the CLI screenshots on Github Pages, combining this two workflows makes sense.
Closes: #1125
Description
Checklist
./scripts/format
and./scripts/test
locally to ensure this change passes linter check and test (not applicable)Expected behavior
After every push to master branch, this Github Action Workflow will be triggered and will update the CLI screenshots and also updated the images on Github Pages (if any change is detected).
Steps to Test This Pull Request
I tested manually using an clone of commitizen repo.
General view of workflow:
Update CLI screenshots using the scripts/gen_cli_help_screenshots.py (I add ci_v3 to command descriptions just to workflow detect changes and to maintain traceability):
Update the images on Github Pages:
Image successfully updated on Github Pages:
Relevant changes (@Lee-W)
generate-cli-screenshots
toupdate-cli-screenshots
[skip ci]
in the description of the commit generated by the jobupdate-cli-screenshots
. The final step of this job is create an commit and push to master. And the workflow is triggered by pushes to master, so if we not add[skip ci]
, the workflow starts an infinite loopupdate-cli-screenshots