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

chore: minor improvement to docs generation #477

Merged
merged 5 commits into from
Aug 13, 2024

Conversation

IronCore864
Copy link
Contributor

@IronCore864 IronCore864 commented Aug 8, 2024

Minor fix to the automated doc generation.

Changes:

  • When getting command help output, use go run ./cmd/pebble.
  • GitHub Actions job to check if the automated CLI reference docs have been changed.
  • Regenerate CLI command reference doc to fix stty cols 80 issue.

@IronCore864 IronCore864 marked this pull request as ready for review August 8, 2024 05:52
Copy link
Contributor

@benhoyt benhoyt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for this. Couple of comments. I also don't fully understand why the columns thing is now fixed.

.github/workflows/tests.yml Outdated Show resolved Hide resolved
.github/workflows/tests.yml Outdated Show resolved Hide resolved
docs/generate_command_docs.py Show resolved Hide resolved
@IronCore864
Copy link
Contributor Author

Add some notes for the issue of the column in case we need to reinvestigate it in the future:

  • My env is multipass.
  • After abundant testing, stty cols works steadily if no terminal-resizing is done during the period the script is running. The behaviour is consistent regardless of the terminal width.
  • Broken output can be reproduced steadily if the terminal width is resized while the script runs.

@IronCore864
Copy link
Contributor Author

Upgraded to python 3.12 and the latest version of tox (4.17). Triggered the CI test and it passed: https://github.com/canonical/pebble/actions/runs/10313091679/job/28549325132?pr=477.

@IronCore864 IronCore864 merged commit fb61907 into canonical:master Aug 13, 2024
17 checks passed
@IronCore864 IronCore864 deleted the docs-improvement branch August 13, 2024 02: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.

2 participants