From 0336fd8328ee01003a0a47d5a95978979166747f Mon Sep 17 00:00:00 2001 From: patrick brisbin Date: Thu, 2 Nov 2023 11:06:44 -0400 Subject: [PATCH] Boilerplate --- README.md | 4 ++-- action.yml | 8 ++++---- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 272104c..c153b46 100644 --- a/README.md +++ b/README.md @@ -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) @@ -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 diff --git a/action.yml b/action.yml index 0d4686c..48011cc 100644 --- a/action.yml +++ b/action.yml @@ -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.