Lock Action
ActionsTags
(2)Lock Action is a GitHub Action that enables branch-based lock management within a repository, allowing workflows to coordinate or control concurrent operations by locking keys.
To use this action, configure it in your GitHub workflow as follows:
- name: Lock Action
uses: daxartio/lock-action@vX.X.X
with:
mode: <lock|unlock|check> # Required. Set the mode to "lock", "unlock", or "check".
key: <unique-key> # Required. Unique key to manage locks per service or environment.jobs:
example:
runs-on: ubuntu-latest
steps:
- name: Lock Resource
uses: daxartio/lock-action@vX.X.X
with:
mode: lock
key: service-prod
- name: Perform Critical Operation
run: echo "Critical operation running..."
- name: Unlock Resource
uses: daxartio/lock-action@vX.X.X
with:
mode: unlock
key: service-prod| Name | Description | Required | Default |
|---|---|---|---|
mode |
Operation mode: lock, unlock, or check. |
Yes | - |
key |
Lock key, used to manage locks by service or environment. | Yes | - |
key_prefix |
Prefix for the lock key. Creates and updates branch ${keyPrefix}${key} for each key. |
No | lock- |
github_token |
GitHub Access Token with contents:write permission to create branches and commits. |
No | ${{ github.token }} |
repo_owner |
Repository owner for creating branches. Defaults to $GITHUB_REPOSITORY_OWNER. |
No | - |
repo_name |
Repository name for creating branches. Defaults to the repository name of $GITHUB_REPOSITORY. |
No | - |
message |
Reason and context message for lock/unlock operations. | No | - |
ignore_already_locked_error |
If true, the action does not fail if the lock is already acquired. |
No | false |
unlock_wait_enabled |
If true, the action waits for lock release if it's already held. |
No | true |
unlock_wait_timeout |
Max time (in seconds) to wait for the lock release. Only used if unlock_wait_enabled is true. |
No | 10 |
unlock_wait_interval |
Interval (in seconds) between checks for lock release. Only relevant if unlock_wait_enabled is true. |
No | 1 |
| Name | Description |
|---|---|
already_locked |
Indicates if the key is already locked. |
result |
Result of the lock operation. |
jobs:
lock-and-unlock:
runs-on: ubuntu-latest
steps:
- name: Lock Resource
uses: daxartio/lock-action@vX.X.X
with:
mode: lock
key: example-key
- name: Perform Critical Task
run: echo "Running a critical task..."
- name: Unlock Resource
uses: daxartio/lock-action@vX.X.X
with:
mode: unlock
key: example-keyjobs:
wait-for-lock:
runs-on: ubuntu-latest
steps:
- name: Wait and Acquire Lock
uses: daxartio/lock-action@vX.X.X
with:
mode: lock
key: example-key
unlock_wait_enabled: true
unlock_wait_timeout: 20- Ensure the GitHub token used has
contents:writepermissions to create branches and commits. - Use the
unlock_wait_enabled,unlock_wait_timeout, andunlock_wait_intervalinputs to control lock acquisition behavior when the lock is already held.
Lock Action is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.
Tags
(2)Lock Action is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.