Examples directory causing error

[abell-agero]

Hi,

I am trying to use this action when copying public AWS modules into a private repo. When doing so, those modules have an examples subfolder of the module. I was adding the KMS module under aws folder and this is the output of the action running:

Fetching pull request commits
  Found 18 files changed in pull request.
  [
    "aws/kms/CHANGELOG.md",
    "aws/kms/LICENSE",
    "aws/kms/README.md",
    "aws/kms/examples/README.md",
    "aws/kms/examples/complete/README.md",
    "aws/kms/examples/complete/main.tf",
    "aws/kms/examples/complete/outputs.tf",
    "aws/kms/examples/complete/variables.tf",
    "aws/kms/examples/complete/versions.tf",
    "aws/kms/main.tf",
    "aws/kms/outputs.tf",
    "aws/kms/variables.tf",
    "aws/kms/versions.tf",
    "aws/kms/wrappers/README.md",
    "aws/kms/wrappers/main.tf",
    "aws/kms/wrappers/outputs.tf",
    "aws/kms/wrappers/variables.tf",
    "aws/kms/wrappers/versions.tf"
  ]
  Found 1 commit.
  Elapsed time fetching commits: 845.887ms
Fetching repository tags
Fetching repository releases
Finding all Terraform modules with corresponding changes
  Parsing commit 3b7cff32a4fa4f9862613579e594464ed7d66839: Add KMS module v3.1.1 (Changed Files = 18)
  Analyzing file: aws/kms/CHANGELOG.md
  Excluding module "aws/kms" match from "aws/kms/CHANGELOG.md" due to exclude pattern match.
  Analyzing file: aws/kms/LICENSE
  Analyzing file: aws/kms/README.md
  Excluding module "aws/kms" match from "aws/kms/README.md" due to exclude pattern match.
  Analyzing file: aws/kms/examples/README.md
  Excluding module "aws/kms" match from "aws/kms/examples/README.md" due to exclude pattern match.
  Analyzing file: aws/kms/examples/complete/README.md
  Excluding module "aws/kms/examples/complete" match from "aws/kms/examples/complete/README.md" due to exclude pattern match.
  Analyzing file: aws/kms/examples/complete/main.tf
  Error: Found changed file "aws/kms/examples/complete/main.tf" associated with a terraform module "aws/kms/examples/complete"; however, associated module does not exist

My action has examples in the excluded dirs:

name: Terraform Module Releaser
on:
  pull_request:
    types: [opened, reopened, synchronize, closed] # Closed required
    branches:
      - main

permissions:
  contents: write # Required for to push tags, create release, and push changes to the wiki
  pull-requests: write # Required to comment on pull request

jobs:
  release:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v4

      - name: Terraform Module Releaser
        uses: techpivot/terraform-module-releaser@v1
        with:
          major-keywords: major update,breaking change
          minor-keywords: feat,feature
          patch-keywords: fix,chore,docs
          default-first-tag: v1.0.0
          terraform-docs-version: v0.19.0
          delete-legacy-tags: false
          disable-wiki: true
          wiki-sidebar-changelog-max: 10
          module-change-exclude-patterns: .gitignore,*.md,*.tftest.hcl,tests/**,examples/**
          module-asset-exclude-patterns: .gitignore,*.md,*.tftest.hcl,tests/**,examples/**
          use-ssh-source-format: false

Thanks!

[virgofx]

Hi @abell-agero . You're configuration looks correct there may be a bug. Without testing and off the cuff have you tried a few variations of the examples/**, such as:

**/examples/**
or maybe
**/examples/**/*

Let me know if those fix the issue. Separately, I believe there's still an issue because your examples/** should match exactly and I'll look into this case exactly to test.

---

After further looking at the logs, it appears there is a bug. I think the analyzer is correctly excluding it but it takes precedence after finding the module in source. Definitely a bug likely. Will continue to investigate and follow up.

[abell-agero]

Hey @virgofx , thanks for the tips! I tried those and confirmed they show in the config of the run but unfortunately show the same error on the same file.

Tried:
**/examples/**/**
**/examples/**/*
**/examples/**

Let me know if you need anything else or any other tests, thanks!

[virgofx]

Hi @abell-agero . I started working on this and I've confirmed I've isolated the issue. I pulled the same kms public module to test as well which helped. Also, it's somewhat related to #157. The first part/fix here is to allow modules to exist in subdirectories. Which is what I'm going to do. For example

/aws/kms as a module
and
/aws/kms/examples/complete as a module

Each would get a corresponding tag and exist independently as they have separate .tf files in them. Originally, I had ignored subdirectories so once traversing /aws/kms it would no longer navigate sub-directories; however, the changed files detected in there would conflict with no module being found.

Intuitively, Terraform by default only registers local .tf and related files in it's direct directory. While one can load other files for use manually, the actual Terraform files scanned for a root don't traverse sub-directories. Thus, it's entirely possible to have separate modules nested. So first fix will make that work.

Then separately, since it's not a good idea to have anything in the **/examples be included as a module and as noted here #157 -- I'm going to add a new variable to exclude paths (relative to the workspace directory) that will be completely excluded as being a module. I'm hoping to have a new release ready to test soon.

[abell-agero]

Very cool, thank you! I think this'll work for my use case. Even if I were to update something in the examples directory, I don't need a new version since the examples would be browsed to from Github directly and not used in TF.

Thanks again for quick investigation and turnaround!

[virgofx]

Hi @abell-agero - I just released v1.5.0 with the module-path-ignore flag in addition to the ability to allow modules per subdirectory. Thus, in the case of KMS, the examples will also work by default ; however, you can completely exclude this now. Let me know if you're able to test and confirm if this works for you? Thanks!