changelog prepare-artifact cli command
docs-builder changelog prepare-artifact \
--staging-dir <string> \
--output-dir <string> \
--evaluate-status <string> \
--generate-outcome <string> \
--pr-number <int> \
--head-ref <string> \
--head-sha <string> \
[options]
(CI) Package changelog artifact for cross-workflow transfer.
--staging-dirstringrequired- Directory where changelog add wrote the generated YAML
--output-dirstringrequired- Directory to write the artifact (metadata.json + YAML)
--evaluate-statusstringrequired- Status output from the evaluate-pr step
--generate-outcomestringrequired- Outcome of the changelog add step (success/failure)
--pr-numberintrequired- Pull request number
--head-refstringrequired- PR head branch ref
--head-shastringrequired- PR head commit SHA
--[no-]is-fork- Whether the PR is from a fork (pass --is-fork / --no-is-fork; omit to leave null which is treated as false)
--[no-]can-commit- Whether the commit strategy allows committing (pass --can-commit / --no-can-commit; omit to leave null which is treated as false)
--[no-]maintainer-can-modify- Whether the fork PR allows maintainer edits (pass --maintainer-can-modify / --no-maintainer-can-modify; omit to leave null which is treated as false)
--head-repostring- Fork repository full name (owner/repo)
--label-tablestring- Optional: markdown label table from evaluate-pr
--product-label-tablestring- Optional: markdown product label table from evaluate-pr
--skip-labelsstring- Optional: comma-separated skip labels from evaluate-pr
--configstring- Optional: path to changelog.yml
--existing-changelog-filenamestring- Optional: filename of a previously committed changelog for this PR
-l--log-levelenum-
Minimum log level.
Values: trace, debug, information, warning, error, critical, none
Default:
information -c--config-sourceenum-
Override the configuration source: local, remote
Values: local, remote, embedded
--[no-]skip-private-repositories- Skip cloning private repositories
-l--log-levelenum-
Minimum log level.
Values: trace, debug, information, warning, error, critical, none
Default:
information -c--config-sourceenum-
Override the configuration source: local, remote
Values: local, remote, embedded
--[no-]skip-private-repositories-
Skip cloning private repositories