Skip to content

Commit

Permalink
Boilerplate
Browse files Browse the repository at this point in the history
  • Loading branch information
pbrisbin committed Nov 2, 2023
1 parent e7a47b5 commit 0336fd8
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Wait for, acquire, and release a distributed lock via S3 storage.
- run: echo "Lock held, do work here"
```
The lock is released in our Post step, or when it expires
The lock is released in our Post step, or when it expires.
![](./screenshot.png)
Expand All @@ -51,7 +51,7 @@ This tool implements a version of the locking algorithm described in this
means by `created` then `uuid` as desired.

- If the first one (i.e. oldest) is our own, we've acquired the lock
- If not, we lost the race; remove our object (and try again)
- If not, we lost the race; remove our object, wait, and try again

### Ordering Semantics

Expand Down
8 changes: 4 additions & 4 deletions action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,16 @@ name: aws-s3-lock
description: Wait on, acquire, and clean-up S3-based locks
author: "Freckle"
inputs:
bucket:
description: |
Name of an existing S3 bucket to use.
required: true
name:
description: |
Name for the lock object. Include any prefix you want within the bucket.
The key will be built as "name.created.uuid.expires".
required: true
default: "${{ github.workflow }}/${{ github.job }}"
bucket:
description: |
Name of an existing S3 bucket to use.
required: true
expires:
description: |
How long before concurrent operations consider this lock expired.
Expand Down

0 comments on commit 0336fd8

Please sign in to comment.