diff --git a/.config/.terraform-docs.yml b/.config/.terraform-docs.yml index fcf35fb..179c8a2 100644 --- a/.config/.terraform-docs.yml +++ b/.config/.terraform-docs.yml @@ -14,8 +14,8 @@ sections: - modules content: |- - # AWS EKS Helm release Terraform module - A Terraform module which configures your AWS EKS Helm release. + {{ include "./.config/title.md"}} + {{ .Header }} ## Example diff --git a/.config/footer.md b/.config/footer.md index b2c2b0f..5232e4d 100644 --- a/.config/footer.md +++ b/.config/footer.md @@ -6,4 +6,4 @@ Checkout our other :point_right: [terraform modules](https://registry.terraform. ## Copyright -Copyright © 2017-2023 [Blackbird Cloud](https://www.blackbird.cloud) \ No newline at end of file +Copyright © 2017-2024 [Blackbird Cloud](https://blackbird.cloud) diff --git a/.config/header.md b/.config/header.md index 0bb538a..60cf1ef 100644 --- a/.config/header.md +++ b/.config/header.md @@ -1 +1 @@ -[![blackbird-logo](https://raw.githubusercontent.com/blackbird-cloud/terraform-module-template/main/.config/logo_simple.png)](https://www.blackbird.cloud) \ No newline at end of file +[![blackbird-logo](https://raw.githubusercontent.com/blackbird-cloud/terraform-module-template/main/.config/logo_simple.png)](https://blackbird.cloud) \ No newline at end of file diff --git a/.config/title.md b/.config/title.md new file mode 100644 index 0000000..3b82046 --- /dev/null +++ b/.config/title.md @@ -0,0 +1,2 @@ +# Terraform Aws Eks Helm Release Module +Terraform module to assist in deploying Helm releases on your AWS EKS cluster. \ No newline at end of file diff --git a/.github/workflows/format.yml b/.github/workflows/format.yml index 6bf95f1..d487763 100644 --- a/.github/workflows/format.yml +++ b/.github/workflows/format.yml @@ -1,8 +1,9 @@ name: Validate and Format -# on: push + on: - pull_request_target: - types: [opened, synchronize] + workflow_dispatch: + # pull_request_target: + # types: [opened, synchronize] jobs: format: @@ -11,7 +12,7 @@ jobs: container: blackbirdcloud/terraform-toolkit:latest steps: - name: Checkout - uses: actions/checkout@v3 + uses: actions/checkout@v4 with: repository: ${{ github.event.pull_request.head.repo.full_name }} ref: ${{ github.event.pull_request.head.ref }} @@ -30,4 +31,4 @@ jobs: - name: Commit and push uses: EndBug/add-and-commit@v9 with: - default_author: github_actions + default_author: github_actions \ No newline at end of file diff --git a/.github/workflows/readme.yml b/.github/workflows/readme.yml index f96fbd1..2fcce86 100644 --- a/.github/workflows/readme.yml +++ b/.github/workflows/readme.yml @@ -1,15 +1,23 @@ -name: Generate terraform docs +name: Generate Readme + on: - - pull_request + push: + branches: + - main + workflow_dispatch: jobs: - docs: + generate-readme: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v3 + - uses: actions/create-github-app-token@v1 + id: app-token with: - ref: ${{ github.event.pull_request.head.ref }} - + app-id: ${{ vars.BB_REPO_MANAGER_APP_ID }} + private-key: ${{ secrets.BB_REPO_MANAGER_SECRET }} + - uses: actions/checkout@v4 + with: + token: ${{ steps.app-token.outputs.token }} - name: Render terraform docs and push changes back to PR uses: terraform-docs/gh-actions@main with: @@ -17,3 +25,4 @@ jobs: config-file: .config/.terraform-docs.yml git-push: "true" output-method: replace + \ No newline at end of file