Enable Verified Commits (with GPG key as secret)

[dgteixeira]

What problem are you facing?

I have Repositories that need to enforce Signed Commits, and would like to keep this action.

How could terraform-docs help solve your problem?

1st Hypothesis:

• Integrate with the action the possibility to use GPG keys to verify the commits, when pushing.

2nd Hypothesis:

• Fix Issue The action runs as the root user, causing subsequent workflows to fail #50, so that we can use other addons such as crazy-max/ghaction-import-gpg@v2 and Add & Commit to improve our commits.

[pfilourenco]

Any update on this?

[apalmercari]

Any update on this?

[sunnyoswalcro]

Any update on this?

[SVendittelli]

While this did not solve my issue, it may help other people here: https://gist.github.com/swinton/03e84635b45c78353b1f71e41007fc7c

[exaucae]

how far are we from solving this with #110 ?

[dgteixeira]

@exaucae, I believe that that PR might solve this issue, yes :)

One extra idea, might be to use the GraphQL API that uses GitHub's GPG key to verify the commits, through this GHA - https://github.com/planetscale/ghcommit-action

I saw this idea here: actions/runner#667 (comment)

[etiennetremel]

Based on @dgteixeira suggestion and for anyone looking for a quick solution until #110 get merged, the following push verified commits:

on:
  pull_request:
    types: [opened, synchronize, reopened]

jobs:
  docs:
    runs-on: ubuntu-latest
    permissions:
      contents: write
    steps:
    - uses: actions/checkout@v4
      with:
        ref: ${{ github.event.pull_request.head.ref }}
    - uses: terraform-docs/gh-actions@main
      with:
        working-dir: .
        recursive: true
        recursive-path: modules
        output-file: README.md
        output-method: inject
    - uses: planetscale/[email protected]
      with:
        commit_message: "terraform-docs: automated action"
        repo: ${{ github.repository }}
        branch: ${{ github.head_ref || github.ref_name }}
        file_pattern: 'modules/**/*.md'
      env:
        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}