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

Add CLI documentation #114

Merged
merged 15 commits into from
May 15, 2024
Merged

Add CLI documentation #114

merged 15 commits into from
May 15, 2024

Conversation

CasperWA
Copy link
Collaborator

@CasperWA CasperWA commented Apr 9, 2024

New CLI.md document in the root of the docs folder with a complete API documentation of the CLI.

New pre-commit hook using the locally installed typer to auto-generate the CLI documentation.
Not reasonable as it apparently takes two runs to generate the proper documentation.


To do:

  • Update the new CI job with some helpful messages.

New pre-commit hook using the locally installed `typer` to generate the
CLI documentation.
Copy link

codecov bot commented Apr 9, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.27%. Comparing base (1d13cc7) to head (49b886e).

❗ Current head 49b886e differs from pull request most recent head 3eda708. Consider uploading reports for the commit 3eda708 to get more accurate results

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #114      +/-   ##
==========================================
- Coverage   92.27%   92.27%   -0.01%     
==========================================
  Files          27       27              
  Lines        1386     1385       -1     
==========================================
- Hits         1279     1278       -1     
  Misses        107      107              
Flag Coverage Δ
docker 80.28% <ø> (+0.05%) ⬆️
local 91.19% <ø> (-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.

@CasperWA CasperWA linked an issue May 14, 2024 that may be closed by this pull request
Reroute stderr to stdout before rerouting stdout to a file.
@CasperWA CasperWA marked this pull request as ready for review May 14, 2024 08:18
@CasperWA CasperWA requested a review from Treesarj May 14, 2024 08:18
@CasperWA CasperWA enabled auto-merge (squash) May 15, 2024 11:12
@CasperWA CasperWA merged commit 7d4ebcf into main May 15, 2024
17 checks passed
@CasperWA CasperWA deleted the cwa/automate-cli-docs branch May 15, 2024 11:14
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.

📄 Document the CLI API
2 participants