Inputs and outputs

Everything the action accepts and returns.

Every input and output of the action, generated from action.yml so the tables always match the version in the repository.

The tables below are generated from action.yml when this site is rendered, so they always describe the version of the action in this repository.

Inputs

Input	Description	Required	Default
`github-token`	GitHub token for creating pull requests	Yes	`${{ github.token }}`
`workspace-path`	Path to the workspace containing _extensions directory	No	`.`
`scan-directories`	Newline-separated list of directories (relative to workspace-path) to scan for _extensions. Each directory is scanned independently.	No	`.`
`registry-url`	URL to the Quarto extensions registry JSON file	No	`https://m.canouil.dev/quarto-extensions/extensions.json`
`create-pr`	Whether to create a pull request for updates	No	`true`
`branch-prefix`	Prefix for the update branch name	No	`chore/quarto-extensions`
`base-branch`	Base branch to create pull requests against	No	`main`
`pr-title-prefix`	Prefix for PR titles (e.g., ‘chore(deps):’ or ‘build:’)	No	`chore(deps):`
`commit-message-prefix`	Prefix for commit messages (e.g., ‘chore(deps):’ or ‘build:’)	No	`chore(deps):`
`pr-labels`	Comma-separated list of labels to add to PRs (e.g., ‘dependencies,quarto-extensions,automated’)	No	`dependencies,quarto-extensions`
`auto-merge`	Enable automatic merging of PRs based on auto-merge-strategy	No	`false`
`auto-merge-strategy`	Auto-merge strategy: ‘patch’ (patch only), ‘minor’ (minor and patch), ‘all’ (all updates)	No	`patch`
`auto-merge-method`	Merge method to use: ‘merge’, ‘squash’, or ‘rebase’	No	`squash`
`include-extensions`	Comma-separated list of extensions to include (e.g., ‘owner/name1,owner/name2’). If specified, only these extensions will be updated.	No	`""`
`exclude-extensions`	Comma-separated list of extensions to exclude (e.g., ‘owner/name1,owner/name2’). These extensions will be skipped.	No	`""`
`group-updates`	Group all extension updates into a single PR instead of creating one PR per extension	No	`false`
`update-strategy`	Control which types of updates to apply: ‘all’ (all updates), ‘minor’ (minor and patch only), ‘patch’ (patch only)	No	`all`
`dry-run`	Run in dry-run mode: check for updates and report what would be done without creating PRs or making changes	No	`false`
`create-issue`	In dry-run mode, create a GitHub issue with the update summary (defaults to false)	No	`false`
`pr-reviewers`	Comma-separated list of GitHub usernames to request as reviewers on created PRs (e.g., ‘user1,user2’)	No	`""`
`pr-team-reviewers`	Comma-separated list of GitHub team slugs to request as reviewers on created PRs (e.g., ‘team1,team2’)	No	`""`
`pr-assignees`	Comma-separated list of GitHub usernames to assign to created PRs (e.g., ‘user1,user2’)	No	`""`

Only github-token is required, and it defaults to the token of the running workflow. An input whose default is "" is inactive unless set.

Outputs

Output	Description
`updates-available`	Whether updates are available (true/false)
`update-count`	Number of updates available
`updates`	JSON array of updates (name, currentVersion, latestVersion)
`pr-number`	Pull request number (if created)
`pr-url`	Pull request URL (if created)
`issue-number`	Issue number (if created in dry-run mode)
`issue-url`	Issue URL (if created in dry-run mode)

Outputs are read through the step identifier, as in check for updates without creating a pull request.