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

Update deployment CD and CLI docs build #212

Merged
merged 12 commits into from
Nov 20, 2024
Merged

Conversation

CasperWA
Copy link
Collaborator

Fixes #211

Copilot summary

This pull request includes several changes to the CI/CD workflows and related scripts to enhance the deployment process and improve the CLI documentation generation. The most significant changes are listed below.

CI/CD Workflow Enhancements:

  • .github/workflows/cd_onto-ns.yml: Updated the workflow to handle manual deployments via workflow_dispatch event and added a step to set up Python 3.10.
  • .github/workflows/ci_tests.yml: Included an additional optional dependency for CI (ydiff) and improved the CLI documentation generation process to ensure the main app documentation is correctly generated.

CLI Documentation:

  • build_cli_docs.sh: Added a new script to automate the generation and updating of CLI documentation, with checks to ensure the typer tool is installed and the documentation file exists.

Dependency Management:

  • pyproject.toml: Added a new optional dependency group ci for CI-specific tools like ydiff.

Copy link

codecov bot commented Nov 20, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 93.08%. Comparing base (7c5fd53) to head (f307328).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #212   +/-   ##
=======================================
  Coverage   93.08%   93.08%           
=======================================
  Files          29       29           
  Lines        1577     1577           
=======================================
  Hits         1468     1468           
  Misses        109      109           
Flag Coverage Δ
docker 81.29% <ø> (ø)
local 92.26% <ø> (ø)

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.


🚨 Try these New Features:

@CasperWA
Copy link
Collaborator Author

CasperWA commented Nov 20, 2024

The CI job for checking the CLI docs build seems to function as intended now, failing if changes exist (see this run) and succeeding if there are no changes detected (see this run).

@CasperWA CasperWA merged commit 8e73b2c into main Nov 20, 2024
20 checks passed
@CasperWA CasperWA deleted the cwa/fix-211-broken-list-cmd branch November 20, 2024 14:37
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.

The list functionality seems to be broken
1 participant