sgibson91/Bump JupyterHub Docker image tags
For a given JupyterHub who's configurgation is stored in a plain text file checked into version control, this action will establish which images that hub is using to provide the computational environment, check if a more recent tag for that image has been released, and open a Pull Request with any changes.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| config_path | Path to the JupyterHub configuration file relative to the root of the repository. | yes | — |
| images_info | A list of dictionaries describing each image to be bumped by the action. Each dictionary should contain a 'values_path' key containing a valid JMESPath expression locating the image in the JupyterHub configuration file. Optionally, a 'regexpr' key can be provided to describe the format of the tag to use from the repository. This can be useful if the image publishes a range of different styles of tags. | yes | — |
| github_token | A GitHub token to make requests to the API with. Requires write permissions to: create new branches, make commits, and open Pull Requests. Defaults to `token` from the GitHub context, which is functionally equivalent to `secrets.GITHUB_TOKEN`. | no | ${{ github.token }} |
| repository | A GitHub repository containing the config for a JupyterHub deployment. Defaults to `repository` from the GitHub context. | no | ${{ github.repository }} |
| base_branch | The name of the base branch Pull Requests will be merged into. Defaults to `main`. | no | main |
| head_branch | The name of the branch changes will be pushed to and the Pull Request will be opened from. Defaults to `bump_image_tags-WXYZ` where `WXYZ` will be a randomly generated ascii string (to avoid clashes). | no | bump-image-tags |
| labels | A comma-separated list of labels to apply to the opened Pull Request. Labels must already exist in the repository. | no | — |
| reviewers | A comma-separated list of GitHub users (without the leading `@`) to request reviews from. | no | — |
| team_reviewers | A comma-separated list of GitHub teams to request reviews from. | no | — |
| push_to_users_fork | The username to create a fork of the repository under. The Pull Request will be opened from a branch in this repository. IMPORTANT: If using this option, then GITHUB_TOKEN should be a PAT from the user account where the repository will be forked to. | no | — |
| dry_run | Perform a dry-run of the action. A Pull Request will not be opened, but a log message will indicate if any image tags can be bumped. | no | — |
Outputs
no outputs