chore: merge v1 branch into master

Author: lentidas

.github/pull_request_template.md

@@ -0,0 +1,5 @@
+## Description of the changes
+
+_In this section, explain **what and why** not how._
+
+_In most cases, you can leave out details about how a change has been made. Code is generally self-explanatory in this regard (and if the code is so complex that it needs to be explained in prose, that’s what source comments are for). Just focus on making clear the reasons why you made the change in the first place, the way things worked before the change (and what was wrong with that), the way they work now, and why you decided to solve it the way you did._

.github/scripts/app-diff.sh

@@ -0,0 +1,18 @@
+---
+name: "commits-checks"
+
+on: 
+  pull_request:
+
+jobs:
+  commits-checks:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: "Check out the repository"
+      uses: actions/checkout@v3
+      with:
+        fetch-depth: 0 # Fetch all history for all tags and branches
+
+    - name: "Check commit messages"
+      uses: docker://aevea/commitsar

.github/workflows/commits-checks.yaml

@@ -6,7 +6,7 @@
 # order to be easily maintained across modules. Because of this, please make sure you're not introducing any breaking 
 # changes when modifying this workflow.
 
-name: "Linters"
+name: "modules-linters"
 
 on:
   workflow_call:

.github/workflows/linters.yaml

@@ -5,18 +5,19 @@
 # order to be easily maintained across modules. Because of this, please make sure you're not introducing any breaking 
 # changes when modifying this workflow.
 
-name: "Release Modules"
+name: "modules-release-please"
 
 on:
   workflow_call:
 
 jobs:
   release-please:
-    runs-on: "ubuntu-latest"
+    runs-on: ubuntu-latest
     steps:
-    - uses: "google-github-actions/release-please-action@v3"
+    - uses: google-github-actions/release-please-action@v3
       with:
-        release-type: "simple"
+        release-type: simple
+        pull-request-title-pattern: "chore: release ${version}"
         bump-minor-pre-major: true
         extra-files: |
           variables.tf

.github/workflows/modules-linters.yaml

@@ -6,7 +6,7 @@
 # order to be easily maintained across modules. Because of this, please make sure you're not introducing any breaking 
 # changes when modifying this workflow.
 
-name: "Terraform Docs"
+name: "modules-terraform-docs"
 
 on:
   workflow_call:
@@ -17,6 +17,11 @@ on:
         required: false
         default: ""
 
+env:
+  ARGS: "--hide-empty=true --sort=false" # Do not show empty sections and do not sort items
+  DOCS_TPL: "// BEGIN_TF_DOCS\n{{ .Content }}\n// END_TF_DOCS" # Define template compatible with AsciiDoc
+  TABLES_TPL: "// BEGIN_TF_TABLES\n{{ .Content }}\n// END_TF_TABLES" # Define template compatible with AsciiDoc
+
 jobs:
   terraform-docs:
     runs-on: ubuntu-latest
@@ -35,8 +40,8 @@ jobs:
         output-format: asciidoc document
         output-file: README.adoc
         output-method: inject
-        template: "// BEGIN_TF_DOCS\n{{ .Content }}\n// END_TF_DOCS" # Define template compatible with AsciiDoc
-        args: "--hide-empty=true" # Do not show empty sections
+        template: ${{ env.DOCS_TPL }}
+        args: ${{ env.ARGS }}
         git-push: false
 
     - name: "Generate Terraform tables"
@@ -47,8 +52,8 @@ jobs:
         output-format: asciidoc table
         output-file: README.adoc
         output-method: inject
-        template: "// BEGIN_TF_TABLES\n{{ .Content }}\n// END_TF_TABLES" # Define template compatible with AsciiDoc
-        args: "--hide-empty=true" # Do not show empty sections
+        template: ${{ env.TABLES_TPL }}
+        args: ${{ env.ARGS }}
         git-push: false
 
     - name: "Generate Terraform docs for the variants"
@@ -60,8 +65,8 @@ jobs:
         output-format: asciidoc document
         output-file: README.adoc
         output-method: inject
-        template: "// BEGIN_TF_DOCS\n{{ .Content }}\n// END_TF_DOCS" # Define template compatible with AsciiDoc
-        args: "--hide-empty=true" # Do not show empty sections
+        template: ${{ env.DOCS_TPL }}
+        args: ${{ env.ARGS }}
         git-push: false
 
     - name: "Generate Terraform tables for the variants"
@@ -73,15 +78,14 @@ jobs:
         output-format: asciidoc table
         output-file: README.adoc
         output-method: inject
-        template: "// BEGIN_TF_TABLES\n{{ .Content }}\n// END_TF_TABLES" # Define template compatible with AsciiDoc
-        args: "--hide-empty=true" # Do not show empty sections
+        template: ${{ env.TABLES_TPL }}
+        args: ${{ env.ARGS }}
         git-push: false
 
     # This step comes after long hours of debugging permission errors on the workflow when trying to do a commit after
     # executing the terraform-docs actions. See https://github.com/terraform-docs/gh-actions/issues/90
     - name: "Correct ownership of files in preparation for the next step"
-      run: |
-        sudo chown runner:docker -Rv .git
+      run: sudo chown runner:docker -Rv .git
 
     # This step avoids a commit for each previous step and instead commits everything on a single commit
     - name: "Commit changes done in the previous steps"

.github/workflows/modules-release-please.yaml

@@ -0,0 +1,24 @@
+---
+name: "pr-issues-project"
+
+on:
+  workflow_call:
+
+  # issues:
+  #   types: 
+  #   - opened
+  #   - reopened
+  
+  # pull_request:
+  #   types:
+  #   - opened
+  #   - reopened
+
+jobs:
+  add-to-project:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/[email protected]
+      with:
+        project-url: https://github.com/orgs/camptocamp/projects/3/
+        github-token: ${{ secrets.APP_TOKEN}}

.github/workflows/modules-terraform-docs.yaml

@@ -0,0 +1,44 @@
+---
+name: "publish-antora-docs"
+
+on:
+  pull_request:
+    paths:
+    - "docs/**"
+
+  workflow_call:
+
+  workflow_dispatch:
+
+jobs:
+  publish:
+    name: "Publish Antora documentation"
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: "Check out repository"
+      uses: actions/checkout@v3
+      with:
+        fetch-depth: 0 # Fetch all branches and tags
+
+    - name: "Build documentation with Antora"
+      uses: docker://ghcr.io/camptocamp/devops-stack-antora:v3
+      with:
+        args: generate antora-playbook.yml --to-dir public/docs
+
+    - name: "Upload generated artifact"
+      if: github.event_name == 'pull_request'
+      uses: actions/upload-artifact@v3
+      with:
+        name: documentation
+        path: ${{ github.workspace }}/public/docs
+
+    - name: "Deploy documentation to GitHub Pages"
+      if: github.ref_name == 'main' && (github.event_name == 'push' || github.event_name == 'workflow_dispatch' || github.event_name == 'workflow_call')
+      uses: JamesIves/[email protected]
+      with:
+        branch: gh-pages
+        folder: public/docs
+        target-folder: docs
+        commit-message: "ci: publish documentation for ${{ github.sha }}"

.github/workflows/pr-issues-project.yaml

@@ -0,0 +1,52 @@
+---
+name: "publish-website"
+
+on:
+  pull_request:
+    paths:
+    - "website/**"
+
+  push:
+    branches:
+    - "main"
+    paths:
+    - "website/**"
+
+  workflow_dispatch:
+
+jobs:
+  publish-website:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: "Check out the repository"
+      uses: actions/checkout@v3
+      with:
+        submodules: true # Fetch Hugo theme
+        fetch-depth: 0   # Fetch all history for .GitInfo and .Lastmod
+
+    - name: "Setup Hugo"
+      uses: peaceiris/actions-hugo@v2
+      with:
+        hugo-version: "0.92.2"
+        extended: true
+
+    - name: "Build website with Hugo"
+      run: hugo --minify --source 'website' --destination '../public'
+
+    - name: "Upload generated artifact"
+      if: github.event_name == 'pull_request'
+      uses: actions/upload-artifact@v2
+      with:
+        name: website
+        path: "${{ github.workspace }}/public"
+
+    - name: "Deploy website to GitHub Pages"
+      if: (github.event_name == 'push' || github.event_name == 'workflow_dispatch') && github.ref_name == 'main'
+      uses: JamesIves/[email protected]
+      with:
+        branch: gh-pages
+        folder: public
+        commit-message: "ci: publish website for ${{ github.sha }}"
+        clean-exclude: |
+          docs