docs: add examples for the cancel, approve, deny and test actions - #66
Merged
Merged
Conversation
✅ Snyk checks have passed. No issues have been found so far.
💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse. |
ctrliq#61 gave relaunch a section in the CLI usage examples. ctrliq#62, ctrliq#63 and ctrliq#64 added cancel, approve and deny without one, so the only place they appear is the generated command reference, and that page is built from a live server's OPTIONS metadata rather than from the tree. Anybody reading the docs as checked in sees nothing about them. Cancel gets the list of resources it works on and the note that the status printed back can still read running, since the platform stops the job shortly after accepting the request rather than before answering. Approve and deny share a section, being the two answers to the same question.
ctrliq#65 added test on notification_templates, credentials and credential_types and landed without an examples entry, the same gap as the three actions above it. It gets more room than they do because --inputs and --metadata are the part a generated signature cannot convey: they carry values that are not saved yet, which is the point of the endpoint, and either one takes JSON or YAML or @ a file holding it.
blaipr
force-pushed
the
docs/cli-action-examples
branch
from
September 13, 2026 21:51
0e12f80 to
317b77a
Compare
The comment said Dependabot reads the install_requires and extras_require lists straight out of setup.py. ctrliq#37 moved the packaging metadata to PEP 621, so those lists are the dependencies and optional-dependencies tables in pyproject.toml and setup.py holds neither: it is version resolution only and declares nothing to bump. Comment only. Dependabot reads pyproject either way, so nothing about what gets bumped changes. The reason to fix it is that the convention keeps these comments for the reasoning a reviewer cannot reconstruct, and this one pointed at the wrong file.
cigamit
approved these changes
Sep 13, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
#61 gave
relauncha section in the CLI usage examples. #62, #63, #64 and #65 addedcancel,approve,denyandtestwithout one, so the only place those four appear isreference.rst, and that page is generated bysphinxcontrib-autoprogramfrom a live server'sOPTIONSmetadata rather than from anything in the tree. A reader of the docs as checked in finds nothing about them.Three sections, the first two placed after the relaunch one so the job lifecycle examples stay together:
running. The platform accepts the request and stops the job shortly after rather than before it answers, which is surprising the first time you see it.--inputsand--metadataare the part a generated signature cannot convey: they carry values that are not saved yet, which is the point of the endpoint, and either one takes JSON or YAML or@a file holding it.No
CHANGELOG.mdentry: the four actions are already inUnreleasedfrom their own pull requests, and this adds no user-facing change of its own.Verification
reference.rstneeds a running Ascender to build, so a fullmake htmlis not something CI or this branch can do. What was checked instead:docutils, with no new messages. The one error reported is the pre-existing:ref:on line 14, a Sphinx-only role that baredocutilsdoes not know.cli/custom.pyandapi/resources.pyrather than from the pull request descriptions.Also here: the Dependabot pip comment
Added on request rather than as a separate pull request, so note that it is unrelated to the examples above and the
docs:title does not cover it..github/dependabot.ymlsaid the pip ecosystem covers "the install_requires and extras_require lists, which Dependabot reads straight out of setup.py". #37 moved the packaging metadata to PEP 621, so those are thedependenciesandoptional-dependenciestables inpyproject.toml, andsetup.pydeclares neither: it is version resolution only, and contains zero occurrences of either name.Comment only. Dependabot reads
pyproject.tomleither way, so nothing about what gets bumped changes. Both ecosystems keep theirciandbuildprefixes and their labels, verified by parsing the file back.