tfproviderdocs icon indicating copy to clipboard operation
tfproviderdocs copied to clipboard

Provide a github action for tfproviderdocs

Open remyleone opened this issue 4 years ago • 1 comments

Hello, could you provide a github action similar to https://github.com/bflad/tfproviderlint-github-action but for tfproviderdocs ?

remyleone avatar Feb 15 '21 16:02 remyleone

Hi @remyleone 👋 Thank you for your interest here. It would not be too much effort to setup something similar that only supports the latest tool version, I am just not sure when I can get to it given other projects at the moment.

In the meantime, it should be possible to setup something similar with:

jobs:
  example:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2
    - uses: actions/setup-go@v2
      with:
        go-version: 1.16
    - run: go install github.com/bflad/tfproviderdocs
    - run: tfproviderdocs -provider-name xxx

If you are looking to also use the experimental -enable-contents-check flag, it is a little more involved with actions/setup-terraform etc. since it requires the output of terraform providers schema -json currently. If you need that information, please reach out.

bflad avatar Feb 25 '21 19:02 bflad

This project will be archived in preference of the revamped validate command in github.com/hashicorp/terraform-plugin-docs implementing much of the basic validation logic from this project. Feature requests should be submitted over there at this point.

bflad avatar May 19 '24 19:05 bflad