Skip to main content

Module

tfaction also provides features for managing modules (not root modules). To manage a module with tfaction, create a tfaction.yaml in the module's directory and set type: module.

tfaction.yaml
type: module

Scaffolding a Module from a Template​

See Creating a Root Module from a Template.

Testing a Module​

See Lint.

Releasing a Module​

Specify the module path and version to generate a GitHub Tag and Release.

.github/workflows/release_module.yaml
name: Release a Terraform Module
run-name: Release a Terraform Module (${{inputs.module_path}} / ${{inputs.version}})
on:
  workflow_dispatch:
    inputs:
      module_path:
        description: "Module path"
        required: true
      version:
        description: "module version"
        required: true
env:
  TFACTION_TARGET: ${{inputs.module_path}}
jobs:
  release-module:
    timeout-minutes: 10
    name: "release-module (${{inputs.module_path}})"
    runs-on: ubuntu-24.04
    permissions:
      contents: write
    steps:
      - name: Checkout Repository
        uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4.3.1
        with:
          persist-credentials: false
      - uses: aquaproj/aqua-installer@11dd79b4e498d471a9385aa9fb7f62bb5f52a73c # v4.0.4
        with:
          aqua_version: v2.56.6
        env:
          AQUA_GITHUB_TOKEN: ${{github.token}}
      - uses: suzuki-shunsuke/tfaction@latest
        with:
          action: release-module
          version: ${{inputs.version}}
          module_path: ${{inputs.module_path}}