Initial Release
Release notes - sudoblark.python.github-cli 1.0.0
Release doc template by good-docs, see here for their templates.
Available on GitHub here
14th March 2025
Initial release of sudoblark-github-cli, providing CRUD functionality for comments on pull requests within a CLI.
New features
- typer application
Brand new typer application scaffold, and interface, for creating a CLI application.
Usage: sudoblark-github-cli [OPTIONS] COMMAND [ARGS]...
CLI tooling intended to automate operations against GitHub within a CI/CD, or other such programmatic. setting. All commands require a valid GITHUB_TOKEN environment variable to operate.
╭─ Options ─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ --log-level -log [NOTSET|DEBUG|INFO|WARNING|ERROR|CRITICAL] Set the logging level for the application, can also override with LOG_LEVEL environment variable [default: INFO] │
│ --log-format,--format TEXT Set the logging format for the application, can also override with LOG_FORMAT environment variable [default: %(asctime)s - %(module)s - %(levelname)s - %(message)s] │
│ --version -v Show the application's version and exit. │
│ --install-completion Install completion for the current shell. │
│ --show-completion Show completion for the current shell, to copy it or customize the installation. │
│ --help Show this message and exit. │
╰───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ debug-log-config Outputs log messages at all levels, intended as an easy test for your log config. │
│ pull-request Interact with pull requests │
╰───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
Root debug-log-config command:
Usage: sudoblark-github-cli debug-log-config [OPTIONS]
Outputs log messages at all levels, intended as an easy test for your log config.
╭─ Options ─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
- pull-request namespace
Usage: sudoblark-github-cli pull-request [OPTIONS] COMMAND [ARGS]...
Interact with pull requests
╭─ Options ─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ --log-level -log [NOTSET|DEBUG|INFO|WARNING|ERROR|CRITICAL] Set the logging level for the application, can also override with LOG_LEVEL environment variable [default: INFO] │
│ --log-format,--format TEXT Set the logging format for the application, can also override with LOG_FORMAT environment variable [default: %(asctime)s - %(module)s - %(levelname)s - %(message)s] │
│ --version -v Show the application's version and exit. │
│ --help Show this message and exit. │
╰───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ create-comment Create a new comment on a given pull request on a given repository. │
│ read-comment Read comments on a given pull request on a given repository, optionally filtered by user, and output in a verbose table. │
│ update-comment Update an explicit comment, or the last comment by a given user, on a given pull request on a given repository. │
│ delete-comment Delete an explicit comment, or the last comment by a given user, on a given pull request on a given repository. │
│ list Output a concise table of pull requests for the given repository. │
╰───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
Changelog
- Create the initial CLI application to perform CRUD operations on GitHub pull request comments by @benjaminlukeclark in https://github.com/sudoblark/sudoblark.python.github-cli/pull/1
- Add in mkdocs documentation by @benjaminlukeclark in https://github.com/sudoblark/sudoblark.python.github-cli/pull/2
Full Changelog: https://github.com/sudoblark/sudoblark.github-actions.library/commits/1.0.0
Feedback
Submit suggestions for improvements to enquires@sudoblark.com and/or raise an issue.