Use Organization's .github README.md.gotmpl

.dockerignore

@@ -1,2 +1 @@
-.git/*
 vendor/*

.github/workflows/lint.yml

@@ -14,7 +14,12 @@ jobs:
     name: readme
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@master
+      - uses: actions/checkout@v4
+      - name: Fix git safe.directory when run inside container
+        # https://github.com/actions/runner/issues/2033
+        run: |
+          mkdir -p /home/runner/work/_temp/_github_home
+          printf "[safe]\n\tdirectory = /github/workspace" > /home/runner/work/_temp/_github_home/.gitconfig
       - uses: docker://cloudposse/build-harness:latest
         with:
           entrypoint: /usr/bin/make

.gitignore

@@ -3,3 +3,4 @@
 .project
 build-harness.iml
 build-harness
+templates/README.md.gotmpl

Dockerfile

@@ -1,4 +1,5 @@
 FROM golang:1.20.13-alpine3.18
+
 LABEL maintainer="Cloud Posse <[email protected]>"
 
 LABEL "com.github.actions.name"="Build Harness"
@@ -81,13 +82,15 @@ RUN update-alternatives --set terraform /usr/share/terraform/$DEFAULT_TERRAFORM_
 
 # Install tflint
 RUN curl -s https://raw.githubusercontent.com/terraform-linters/tflint/master/install_linux.sh | bash
+
 COPY <<EOF /root/.tflint.hcl
 plugin "aws" {
     enabled = true
     version = "0.26.0"
     source  = "github.com/terraform-linters/tflint-ruleset-aws"
 }
 EOF
+
 RUN tflint --init
 
 # Patch for old Makefiles that expect a directory like x.x from the 0.x days.

modules/readme/Makefile

@@ -1,10 +1,35 @@
 export README_LINT ?= $(TMP)/README.md
 export README_FILE ?= README.md
 export README_YAML ?= README.yaml
+
+export README_TEMPLATE_REPO_REMOTE_NAME ?= origin
+export README_TEMPLATE_REPO_REMOTE ?= $(shell [ -d .git ] && git remote get-url $(README_TEMPLATE_REPO_REMOTE_NAME))
+
+# Parse https://github.com/...
+ifneq (,$(findstring https://github.com/,$(README_TEMPLATE_REPO_REMOTE)))
+URL_NO_PROTOCOL := $(subst https://github.com/,,$(README_TEMPLATE_REPO_REMOTE))
+README_TEMPLATE_REPO_ORG ?= $(firstword $(subst /, ,$(URL_NO_PROTOCOL)))
+endif
+
+# Parse [email protected]:...
+ifneq (,$(findstring [email protected]:,$(README_TEMPLATE_REPO_REMOTE)))
+URL_NO_GIT := $(subst [email protected]:,,$(README_TEMPLATE_REPO_REMOTE))
+README_TEMPLATE_REPO_ORG ?= $(firstword $(subst /, ,$(URL_NO_GIT)))
+endif
+
+export README_TEMPLATE_REPO ?= .github
+export README_TEMPLATE_REPO_REF ?= blob/main
+export README_TEMPLATE_REPO_PATH ?= README.md.gotmpl
+export README_TEMPLATE_REPO_URL ?= https://github.com/$(README_TEMPLATE_REPO_ORG)/$(README_TEMPLATE_REPO)/$(README_TEMPLATE_REPO_REF)/$(README_TEMPLATE_REPO_PATH)?raw=true
 export README_TEMPLATE_FILE ?= $(BUILD_HARNESS_PATH)/templates/README.md.gotmpl
 export README_TEMPLATE_YAML := $(if $(findstring http,$(README_YAML)),$(README_YAML),$(BUILD_HARNESS_PATH)/templates/$(README_YAML))
 export README_INCLUDES ?= $(file://$(shell pwd)/?type=text/plain)
 
+# Create the README.md.gotmpl, if none exists by fetching it from the organization's `.github` repository
+$(README_TEMPLATE_FILE):
+	@echo GitHub Org: $(README_TEMPLATE_REPO_ORG)
+	curl -o $@ -fsSL '$(README_TEMPLATE_REPO_URL)'
+
 ## Alias for readme/build
 readme: readme/build
 	@exit 0
@@ -15,10 +40,10 @@ readme/deps: packages/install/gomplate
 ## Create basic minimalistic .README.md template file
 readme/init:
 	@if [ -f $(README_YAML) ]; then \
-	  echo "$(README_YAML) already exists!"; \
+		echo "$(README_YAML) already exists!"; \
 	else \
-	  cp $(README_TEMPLATE_YAML) $(README_YAML) ; \
-	  echo "$(README_YAML) created!"; \
+		cp $(README_TEMPLATE_YAML) $(README_YAML) ; \
+		echo "$(README_YAML) created!"; \
 	fi;
 
 ## Verify the `README.md` is up to date
@@ -28,7 +53,7 @@ readme/lint:
 	@rm -f $(README_LINT)
 
 ## Create README.md by building it from README.yaml
-readme/build: readme/deps $(README_DEPS)
+readme/build: readme/deps $(README_TEMPLATE_FILE) $(README_DEPS)
 	@gomplate --file $(README_TEMPLATE_FILE) --out $(README_FILE) --config $(BUILD_HARNESS_PATH)/configs/gomplate.yaml
 	@echo "Generated $(README_FILE) from $(README_TEMPLATE_FILE) using data from $(README_TEMPLATE_YAML)"