Introduce Manual Lock Mecanism

[suzuki-shunsuke]

Feature Overview

Introduce Manual Lock Mecanism.

Why is the feature needed?

Sometimes we want to prevent accessing Terraform State and some terraform commands such as plan, apply and import. For example,

1. You want to prevent any changes during an event
2. You want prevent any changes during splitting Terraform State

Example Code

No response

Note

No response

[suzuki-shunsuke]

• We don't want to depend on other services such as AWS and GCP. We want use GitHub features such as branches, issues and GHCR
• Enable us to list locked directories
• Enable us to leave comments when locking and unlocking
• Easy to understand the mechanism

[suzuki-shunsuke]

Operation

• List locked directories
• Lock a directory
• Unlock a directory

How to lock

• workflow_dispatch
• Open an issue
  • Create an issue per directory
• Post a comment to an issue
• Post a comment to a pull request

[suzuki-shunsuke]

Action when the directory is locked

• Wait until the directory is unlocked
  • timeout
• Fail immediately

[suzuki-shunsuke]

• https://github.com/github/lock
• https://github.com/szksh-lab/poc-lock-action/blob/main/.github/workflows/lock.yaml
• https://github.com/szksh-lab/poc-lock-action/blob/main/actions/lock/action.yaml

[suzuki-shunsuke]

I've developed a GitHub Action for lock mechanism.

• https://github.com/suzuki-shunsuke/lock-action