atlantis-emoji-gate

General information

atlantis-emoji-gate is a tool designed to work with Atlantis on GitLab Community Edition (CE) to ensure that a specific emoji reaction is present on a GitLab merge request.

This acts as a replacement for mandatory MR approval (which does not work on CE), and can be used to ensure that a specific person has reviewed the MR before atlantis apply is allowed to run.

graph LR

    subgraph "Open & Plan"
        A[MR is Opened] --> B[Atlantis plan is triggered]
        B --> C[Atlantis adds comment to MR with details]
    end

    subgraph "Validation"
        C --> D[User validates the result]
        D --> E[User adds comment: atlantis apply]
    end

    subgraph "Apply"
        E --> F[Atlantis runs atlantis-emoji-gate]
        F --> G{Code owner added required emoji?}
        G -->|Yes| H[Apply happens]
        G -->|No| I[Apply is aborted]
    end

%% Style the nodes
    style A fill:#EEF3FF,stroke:#8892FF,stroke-width:1px,color:#000
    style B fill:#EEF3FF,stroke:#8892FF,stroke-width:1px,color:#000
    style C fill:#EEF3FF,stroke:#8892FF,stroke-width:1px,color:#000
    style D fill:#FFFFEE,stroke:#D4C200,stroke-width:1px,color:#000
    style E fill:#FFFFEE,stroke:#D4C200,stroke-width:1px,color:#000
    style F fill:#EEFFFF,stroke:#00C2D4,stroke-width:1px,color:#000
    style G fill:#FFFFEE,stroke:#D4C200,stroke-width:2px,color:#000
    style H fill:#DDFFDD,stroke:#09A009,stroke-width:2px,color:#000
    style I fill:#FFDADA,stroke:#CC0000,stroke-width:2px,color:#000

%% Style specific links (6 and 7 from the original diagram)
    linkStyle 6 stroke:green,stroke-width:2px
    linkStyle 7 stroke:red,stroke-width:2px

Loading

Configuration

atlantis-emoji-gate is configured using environment variables. The following variables are available:

Variable	Description	Default	Optional
APPROVE_EMOJI	The emoji that must be present on the MR for atlantis apply to be allowed to run	thumbsup	No
CODEOWNERS_PATH	The path to the CODEOWNERS file in the repository	CODEOWNERS	No
CODEOWNERS_REPO	The repository to check for CODEOWNERS file		Yes
INSECURE	If MR author is allowed to approve their own MR	false	No

The remaining environment variables are set dynamically by Atlantis and should not be set manually.

Permissions

Given that we have the following repository structure:

.
├── CODEOWNERS
├── other_file.txt
└── terraform
    ├── deploy
    │   └── main.tf
    └── provision
        └── main.tf

CODEOWNERS file example:

* @username1
/terraform @username4
/terraform/provision @username2
/terraform/deploy @username3

Where:

• @username1 would be able to approve any MR
• @username2 would be able to approve MRs that change files in the /terraform/provision directory
• @username3 would be able to approve MRs that change files in the /terraform/deploy directory
• @username4 would be able to approve MRs that change files in both /terraform/provision and /terraform/deploy directories

Workflow example

workflows:
  default:
    plan:
      steps:
        - init
        - plan
    apply:
      steps:
        - run: atlantis-emoji-gate
        - apply

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.