chore(template): sync with ahmadnassri/template-action-composite

Author: Ahmad Nassri

.github/FUNDING.yml

@@ -1 +1,5 @@
+# ------------------------------------------------------------- #
+# Note: this file is automatically managed in template-template #
+# ------------------------------------------------------------- #
+
 github: [ahmadnassri]

.github/workflows/pull_request_target.yml

@@ -6,17 +6,74 @@ on: pull_request_target
 
 name: pull_request_target
 
+permissions:
+  pull-requests: write
+  contents: write
+
 jobs:
+  metadata:
+    runs-on: ubuntu-latest
+
+    outputs:
+      repository: ${{ steps.metadata.outputs.repository }}
+
+    steps:
+      - uses: actions/[email protected]
+
+      - uses: ahmadnassri/action-metadata@v1
+        id: metadata
+
   auto-merge:
     timeout-minutes: 5
 
     runs-on: ubuntu-latest
 
-    # security check: only run with dependabot PRs
-    if: github.actor == 'dependabot[bot]'
+    # only run for dependabot PRs
+    if: ${{ github.actor == 'dependabot[bot]' }}
+
+    env:
+      PR_URL: ${{github.event.pull_request.html_url}}
+      GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
 
     steps:
-      - uses: actions/[email protected]
-      - uses: ahmadnassri/[email protected]
+      - id: dependabot
+        uses: dependabot/[email protected]
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: auto merge conditions
+        id: auto-merge
+        if: |
+          (
+            steps.dependabot.outputs.update-type == 'version-update:semver-patch' &&
+            contains('direct:production,indirect:production', steps.dependabot.outputs.dependency-type)
+          ) || (
+            steps.dependabot.outputs.update-type == 'version-update:semver-minor' &&
+            contains('direct:development,indirect:development', steps.dependabot.outputs.dependency-type)
+          )
+        run: echo "::notice ::auto-merge conditions satisfied"
+
+      - name: auto approve pr
+        if: ${{ steps.auto-merge.conclusion == 'success' }}
+        run: |
+          gh pr review --approve "$PR_URL"
+          gh pr merge --auto --rebase "$PR_URL"
+
+  template-sync:
+    needs: metadata
+
+    timeout-minutes: 20
+
+    runs-on: ubuntu-latest
+
+    # only run for templates
+    if: ${{ fromJSON(needs.metadata.outputs.repository).is_template }}
+
+    steps:
+      - uses: actions/[email protected]
+        with:
+          ref: ${{ github.event.pull_request.head.ref }}
+      - uses: ahmadnassri/[email protected]
+      - uses: ahmadnassri/[email protected]
         with:
           github-token: ${{ secrets.GH_TOKEN }}

.gitignore

@@ -0,0 +1 @@
+*.log

.pandoc.yml

@@ -0,0 +1,15 @@
+# ----------------------------------------------- #
+# Note: this file originates in template-template #
+# ----------------------------------------------- #
+
+input-file: docs/README.md
+output-file: README.md
+metadata-file: colophon.yml
+template: docs/README.template
+
+from: gfm
+to: gfm
+
+wrap: preserve
+reference-links: true
+fail-if-warnings: false

Makefile

@@ -0,0 +1,28 @@
+#!/usr/bin/make
+
+# ------------------------------------------------------- #
+# Note: this file originates in template-action-composite #
+# ------------------------------------------------------- #
+
+# Docker
+
+pull: ## pull latest containers
+	@docker compose pull
+
+lint: ## run super-linter
+	@docker compose run --rm lint
+
+readme: ## run readme action
+	@docker compose run --rm readme
+
+clean: ## remove running containers, volumes, node_modules & anything else
+	@docker compose rm --stop --volumes --force
+
+# Utility methods
+## Help: https://marmelab.com/blog/2016/02/29/auto-documented-makefile.html
+
+help: ## display this help
+	@awk 'BEGIN {FS = ":.*?## "} /^[a-zA-Z_-]+:.*?## / {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}' $(MAKEFILE_LIST)
+
+.DEFAULT_GOAL := help
+.PHONY: help

docker-compose.yml

@@ -1,28 +1,24 @@
-version: '3.8'
+# ------------------------------------------------------- #
+# Note: this file originates in template-action-composite #
+# ------------------------------------------------------- #
 
 services:
   # ---- super-linter ---- #
   lint:
-    image: github/super-linter:v3
+    image: github/super-linter:slim-v4
     volumes:
-      - ./:/tmp/lint
+      - ./:/workspace
     environment:
-      RUN_LOCAL: 'true'
       LOG_LEVEL: 'ERROR'
+      RUN_LOCAL: 'true'
       MULTI_STATUS: 'false'
+      IGNORE_GITIGNORED_FILES: 'true'
+      DEFAULT_WORKSPACE: /workspace
+      FILTER_REGEX_EXCLUDE: '/workspace/README.md'
 
   # ---- readme generator ---- #
   readme:
-    image: pandoc/core:2.11.4
+    image: pandoc/minimal:2.18.0
     volumes:
       - ./:/data
-    command: >-
-      --metadata-file=colophon.yml
-      --template=docs/README.template
-      --output=README.md
-      --from=gfm
-      --to=gfm
-      --fail-if-warnings
-      --wrap=preserve
-      --reference-links
-      docs/README.md
+    command: --defaults=.pandoc.yml