Skip to content

Automatically login to Modulemancer in a GitHub action to pull terraform modules

License

Notifications You must be signed in to change notification settings

Modulemancer/github-action

Use this GitHub action with your project
Add this Action to an existing workflow or create a new one
View on Marketplace

Repository files navigation

Modulemancer - Terraform Private Registry - GitHub Action

This is a GitHub Action to automatically login to Modulemancer to enable the runner to pull modules from Modulemancer.

Review in the GitHub action marketplace

What is Modulemancer?

Modulemancer is a terraform and other infra private module registry. It replaces the Terraform registry with optimized features making it easy to publish, search, and share modules between organizations.

How does this GitHub action work?

It does this by converting the GitHub security token into an Authress identity token which Modulemancer understands. After converting the token, it populates the terraform credentials file for your modulemancer.com registry. The action completes this by creating a TF credentials file is the os-specific location.

Usage

In your GitHub action workflow add the follow step. (For sample usage see the Modulemancer private registry example.)

# Important! This is required: https://docs.github.com/en/actions/security-guides/automatic-token-authentication
permissions:
  id-token: write

jobs:
  build:
    steps:
    - uses: actions/checkout@v2
    - uses: hashicorp/setup-terraform@v1
      with:
        terraform_version: 1.1.9

    # use the github action before terraform init: https://github.com/Modulemancer/github-action
    - uses: modulemancer/github-action@v1

    - name: Terraform Init
      run: terraform init -reconfigure