https://github.com/modulemancer/github-action

Automatically login to Modulemancer in a GitHub action to pull terraform modules
https://github.com/modulemancer/github-action

cicd github-actions modules private-registry terraform terraform-module terraform-provider terraform-registry

Last synced: 24 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/modulemancer/github-action
• Owner: Modulemancer
• License: apache-2.0
• Created: 2022-04-24T12:45:45.000Z (over 2 years ago)
• Default Branch: release/1.0
• Last Pushed: 2022-05-03T12:52:49.000Z (over 2 years ago)
• Last Synced: 2024-11-15T04:36:21.422Z (about 1 month ago)
• Topics: cicd, github-actions, modules, private-registry, terraform, terraform-module, terraform-provider, terraform-registry
• Language: JavaScript
• Homepage:
• Size: 32.6 MB
• Stars: 1
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Modulemancer - Terraform Private Registry - GitHub Action

This is a GitHub Action to automatically login to [Modulemancer](https://modulemanacer.com) to enable the runner to pull modules from Modulemancer.

[Review in the GitHub action marketplace](https://github.com/marketplace/actions/modulemancer-registry-login)

### What is Modulemancer?

[Modulemancer](https://modulemancer.com) 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](https://authress.io) 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](https://www.terraform.io/cli/config/config-file#locations) is the os-specific location.

## Usage

In your GitHub action workflow add the follow step. (For sample usage see the [Modulemancer private registry example](https://github.com/Modulemancer/Example-Infra-Repo).)

```yaml

# 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

```