feat: add versioning requirements, and automatic documentation pipeline #1

Merged
lanson merged 13 commits from feat/versioning into main 2024-09-10 17:19:57 +00:00
2 changed files with 20 additions and 8 deletions
Showing only changes of commit 74a01b5b05 - Show all commits

View File

@ -34,10 +34,22 @@ jobs:
shell: bash
working-directory: ./
- name: Render terraform docs
uses: Dirrk/terraform-docs@v1.0.8
pre-commit-check:
name: Check pre-commit status
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
with:
tf_docs_working_dir: .
tf_docs_output_file: README.md
tf_docs_output_method: inject
tf_docs_git_push: "true"
ref: ${{ github.event.pull_request.head.sha }}
fetch-depth: 0
- name: Install commitizen
run: pip3 install pre-commit
shell: bash
working-directory: ./
- name: Verify pre-commit status
run: pre-commit run --all
shell: bash
working-directory: ./

View File

@ -2,7 +2,7 @@
Terraform module to deploy a completely customizable OpenStack
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
<!-- BEGIN_TF_DOCS -->
### Requirements
| Name | Version |
@ -82,4 +82,4 @@ No modules.
| <a name="output_frontend_subnet"></a> [frontend_subnet](#output_frontend_subnet) | The frontend subnet object (as a list), if created |
| <a name="output_router"></a> [router](#output_router) | The entire router object (as a list), if created |
| <a name="output_subnetpool"></a> [subnetpool](#output_subnetpool) | The subnetpool object (as a list), if created |
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
<!-- END_TF_DOCS -->