conda-incubator/relock-conda
GitHub action to relock conda environments using conda-lock
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| environment-file | the environment to (re)lock | no | environment.yml |
| lock-file | the lock file to update | yes | conda-lock.yml |
| ignored-packages | comma- or newline-separated list of packages whose version changes are ignored when relocking | yes | "" |
| include-only-packages | comma-or newline-separated list of packages to exclusively include when relocking, all others will be ignored, ignored-packages is applied to this list | yes | "" |
| merge-as-admin-packages | comma-or newline-separated list of packages for which all PR requirements (e.g., CI tests) will be skipped and the PR will be merged immediately, if the updated packages from relocking are a subset thereof | yes | "" |
| relock-all-packages | whether to relock on an update to any package in the environment, not just those in the environment file | yes | false |
| github-token | GitHub personal access token to use for making PRs | yes | — |
| action | the action to take if the lock file is updated: `pr` will make a PR; `file` will leave the updated lock file in the current working directory; `commit` will commit the updated lock file and push the changes | yes | pr |
| automerge | whether to automatically merge the PR | yes | false |
| base-branch | the base branch for PRs (See [this documentation](https://github.com/peter-evans/create-pull-request/blob/main/docs/concepts-guidelines.md#events-which-checkout-a-commit) for more details.) | — | — |
| head-branch | the head branch for PRs | yes | relock-conda |
| skip-if-pr-exists | whether to skip relocking if a PR already exists | yes | false |
| draft | whether to open the PR as a draft | yes | false |
| git-user-name | the name to use for git commits; the default of '' attempts to infer the name from the login associated with the GitHub token via the API. if this fails, we use the value `github.actor` from the context. | no | "" |
| git-user-email | the email to use for git commits; the default of '' attempts to infer the email from the login associated with the GitHub token via the API. if this fails, we use '${git-user-name}@users.noreply.github.com'. | no | "" |
Outputs
| name | description |
|---|---|
| pull-request-number | the number of the PR that was opened |
| relocked | whether the environment was relocked |
| summary | the summary of the relock operation |