-
-
Notifications
You must be signed in to change notification settings - Fork 257
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
feat(ci/cd): automates the generation of CLI screenshots #1122
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #1122 +/- ##
==========================================
+ 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. |
Wow nice! LGTM, @Lee-W ? |
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.
LGTM. Thanks!
Closes: #1112 |
ah... I forget to check the commit message. this should be |
Sure! I can rebase/ammend this. Any suggestions about the scope? |
Ops, it got merged already. Sorry for that! @Lee-W |
Yes, I suppose I wasn't actually awake. 🤦♂️ But after a second thought, we probably should move it to https://github.com/commitizen-tools/commitizen/blob/master/.github/workflows/docspublish.yml. otherwise, we might update the image without having them in the doc |
Yeah, makes sense. The suggestion is to move all the steps on generate_cli_screenshots.yml to docspublish.yml, or somehow invoke the generate_cli_screenshots.yml after run docspublish.yml? May I open an another issue to fix this? |
nope, generate_cli_screenshots should be invoked first
Yep, sure :) |
Yes, yes. I thought "before" and wrote "after" lol. So, just to make things clear. The ideia is to delete generate_cli_screenshots.yml and move all the steps on it to docspublish.yml, and steps from generate_cli_screenshots.yml should run before the docspublish.yml steps. Right? |
Description
Checklist
./scripts/format
and./scripts/test
locally to ensure this change passes linter check and test (not applicable)Expected behavior
After any pull requested merged, this Github Action Workflow will be triggered and will updated the CLI screenshots.
Steps to Test This Pull Request
I tested manually using an clone of commitizen repo.
General view:
Generate CLI screenshots using the scripts/gen_cli_help_screenshots.py:
Push updated images to repository: