Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Commit 017f1c5

Browse files
authored
Merge pull request #10 from geekcell/update-templates
docs: update templates
2 parents ddf7089 + 9f23624 commit 017f1c5

File tree

16 files changed

+207
-197
lines changed

16 files changed

+207
-197
lines changed

‎.github/.templatesyncignore‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
README.md
2+
.github/workflows/*
3+
.terraform-docs.yml
4+
docs/20-badges.md
5+
docs/assets/logo.svg
6+
*.tf
7+
test/*
8+
go.mod
9+
go.sum

‎.github/dependabot.yml‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
##############################
3+
## Dependabot configuration ##
4+
##############################
5+
6+
#
7+
# Documentation:
8+
# https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuring-dependabot-version-updates
9+
#
10+
11+
version: 2
12+
updates:
13+
# Maintain dependencies for GitHub Actions
14+
- package-ecosystem: "github-actions"
15+
directory: "/"
16+
schedule:
17+
interval: "daily"
18+
open-pull-requests-limit: 0
19+
20+
# Maintain dependencies for Terraform Providers
21+
- package-ecosystem: "terraform"
22+
directory: "/"
23+
schedule:
24+
interval: "daily"
25+
open-pull-requests-limit: 0
26+
27+
# Maintain dependencies for Golang
28+
- package-ecosystem: "gomod"
29+
directory: "/"
30+
schedule:
31+
interval: "daily"
32+
open-pull-requests-limit: 0

‎.github/labels.yaml‎

Lines changed: 0 additions & 34 deletions
This file was deleted.

‎.github/pull_request-template.md‎

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,6 @@
55

66
...
77

8-
## How this PR fixes it
9-
10-
...
11-
128
## Readiness Checklist
139

1410
### Author/Contributor

‎.github/workflows/release.yaml‎

Lines changed: 25 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
2-
####################################
3-
## Draft releases on Push to main ##
4-
####################################
2+
#####################
3+
## Create releases ##
4+
#####################
55

66
#
77
# Documentation:
@@ -13,9 +13,8 @@ on:
1313
push:
1414
branches: [ main ]
1515
tags: [ 'v*.*.*' ]
16-
17-
permissions:
18-
contents: write
16+
pull_request:
17+
types: [ labeled ]
1918

2019
#################
2120
# Start the job #
@@ -26,6 +25,7 @@ jobs:
2625
###############
2726
create-release:
2827
name: Create Release
28+
if: github.event.action != 'labeled'
2929
runs-on: ubuntu-latest
3030
timeout-minutes: 10
3131
steps:
@@ -75,3 +75,22 @@ jobs:
7575
tag_name: ${{ steps.tag.outputs.value }}
7676
draft: false
7777
prerelease: false
78+
79+
###########################
80+
# Release preview comment #
81+
###########################
82+
release-check:
83+
if: github.event.action == 'labeled'
84+
runs-on: ubuntu-latest
85+
steps:
86+
############################
87+
# Checkout the source code #
88+
############################
89+
- name: Checkout Code
90+
uses: actions/checkout@v3.1.0
91+
92+
#######################
93+
# Post status comment #
94+
#######################
95+
- name: Post bumpr status comment
96+
uses: haya14busa/action-bumpr@v1

‎.github/workflows/sync-templates.yaml‎

Lines changed: 11 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,9 @@
1010

1111
name: Sync templates
1212
on:
13-
workflow_dispatch:
13+
workflow_dispatch: # Trigger manually
14+
schedule:
15+
- cron: "0 0 1 * *" # Run at 00:00 on the first day of every month
1416

1517
##########################
1618
# Prevent duplicate jobs #
@@ -36,7 +38,7 @@ jobs:
3638
- name: Sync labels
3739
uses: EndBug/label-sync@v2.3.1
3840
with:
39-
config-file: https://raw.githubusercontent.com/geekcell/template-terraform-module/main/.github/labels.yaml
41+
config-file: https://gist.githubusercontent.com/Ic3w0lf/f5520c5f19d7098966f692c120f7a197/raw/75b134f76fbc55e2e64bd66f04e571d6d74b815e/terraform-aws-module-labels.yaml
4042

4143
#######################
4244
# Sync template files #
@@ -50,33 +52,12 @@ jobs:
5052
############################
5153
- name: Checkout Code
5254
uses: actions/checkout@v3.1.0
53-
with:
54-
token: ${{ secrets.GEEKCELL_PAT_WORKFLOWS }}
55-
56-
########################
57-
# Patch template files #
58-
########################
59-
- name: Force patching of template files
60-
run: |
61-
yes y | make setup/update-template
62-
63-
####################
64-
# Update README.md #
65-
####################
66-
- name: Terraform docs
67-
uses: terraform-docs/gh-actions@v1.0.0
68-
with:
69-
config-file: .terraform-docs.yml
70-
git-push: false
7155

72-
#############
73-
# Create PR #
74-
#############
75-
- name: Create PR
76-
uses: peter-evans/create-pull-request@v4.2.0
56+
#######################
57+
# Sync template files #
58+
#######################
59+
- name: actions-template-sync
60+
uses: AndreasAugustin/actions-template-sync@v0.7.3
7761
with:
78-
token: ${{ secrets.GEEKCELL_PAT_WORKFLOWS }}
79-
title: Updated template files
80-
commit-message: Update template files from main repo
81-
branch: update-template-files
82-
delete-branch: true
62+
github_token: ${{ secrets.GITHUB_TOKEN }}
63+
source_repo_path: geekcell/terraform-aws-module-template

‎.pre-commit-config.yaml‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,18 @@
11
repos:
22
- repo: https://github.com/antonbabenko/pre-commit-terraform
3-
rev: v1.76.0
3+
rev: v1.80.0
44
hooks:
55
- id: terraform_docs
66
- id: terraform_fmt
77
- id: terraform_validate
8+
args:
9+
- --hook-config=--retry-once-with-cleanup=true
810
exclude: '^[^/]+$'
911
- id: terraform_tflint
1012
exclude: ^examples/
1113

1214
- repo: https://github.com/pre-commit/pre-commit-hooks
13-
rev: v4.3.0
15+
rev: v4.4.0
1416
hooks:
1517
- id: trailing-whitespace
1618
- id: end-of-file-fixer

‎.terraform-docs.yml‎

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,14 @@
11
formatter: "md table"
22
header-from: main.tf
33

4+
recursive:
5+
# Enable this if your module has submodules
6+
enabled: false
7+
48
content: |-
5-
{{ include "docs/logo.md" }}
9+
{{ include "docs/10-header.md" }}
610
7-
{{ include "docs/badges.md" }}
11+
{{ include "docs/20-badges.md" }}
812
913
{{ .Header }}
1014
@@ -19,6 +23,12 @@ content: |-
1923
- {{ .GetMode }}.{{ .Spec }} ({{ .Position.Filename }}#{{ .Position.Line }})
2024
{{- end }}
2125
26+
# Examples
27+
### Basic
28+
```hcl
29+
{{ include "examples/basic-example/main.tf" }}
30+
```
31+
2232
output:
2333
file: "README.md"
2434
mode: inject

0 commit comments

Comments
(0)

AltStyle によって変換されたページ (->オリジナル) /