Merge pull request #141 from hofstadter-io/docs-ci

hof/docs: ci work
hofstadter-io · Feb 26, 2023 · 377035a · 377035a
2 parents bea98af + 3cec1ef
commit 377035a
Show file tree

Hide file tree

Showing 48 changed files with 494 additions and 213 deletions.
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -8,6 +8,14 @@ jobs:
   docs:
     runs-on: ubuntu-latest
     steps:
+      - run: |-
+          mkdir tmp
+          cd tmp
+          wget https://github.com/cue-lang/cue/releases/download/v0.5.0-beta.5/cue_v0.5.0-beta.5_linux_amd64.tar.gz -O cue.tar.gz
+          tar -xf cue.tar.gz
+          sudo mv cue /usr/local/bin/cue
+          cd ../
+          rm -rf tmp
       - name: Install Go
         uses: actions/setup-go@v3
         with:
@@ -39,18 +47,16 @@ jobs:
       - name: Build hof
         run: go install ./cmd/hof
       - name: Setup
-        run: "cd docs\nmake first "
-      - name: Test
-        run: |-
-          cd docs
-          make test
-      - name: Build
         run: |-
+          hof fmt start [email protected]
           cd docs
-          make build
-      - name: Check
+          hof mod link
+          make deps
+      - name: Test
         run: |-
           cd docs
+          make gen
+          make test
           make run &
           make broken-link
     strategy: {}

diff --git a/.github/workflows/release-docs.yml b/.github/workflows/release-docs.yml
@@ -2,11 +2,43 @@ name: release (docs)
 "on":
   push:
     tags:
-      - docs-*
+      - docs-**
+  workflow_dispatch:
+    inputs:
+      deploy:
+        description: where to deploy
+        required: true
+        default: next
+        type: choice
+        options:
+          - next
+          - prod
 jobs:
   docs:
     runs-on: ubuntu-latest
+    environment: hof docs
     steps:
+      - run: |-
+          mkdir tmp
+          cd tmp
+          wget https://github.com/cue-lang/cue/releases/download/v0.5.0-beta.5/cue_v0.5.0-beta.5_linux_amd64.tar.gz -O cue.tar.gz
+          tar -xf cue.tar.gz
+          sudo mv cue /usr/local/bin/cue
+          cd ../
+          rm -rf tmp
+      - name: Install Go
+        uses: actions/setup-go@v3
+        with:
+          go-version: 1.20.x
+      - uses: actions/cache@v3
+        with:
+          path: |-
+            ~/go/pkg/mod
+            ~/.cache/go-build
+            ~/Library/Caches/go-build
+            ~\AppData\Local\go-build
+          key: ${{ runner.os }}-go-${{ matrix.go-version }}-${{ hashFiles('**/go.sum') }}
+          restore-keys: ${{ runner.os }}-go-${{ matrix.go-version }}-
       - name: Checkout code
         uses: actions/checkout@v3
       - name: Setup Vars
@@ -20,7 +52,34 @@ jobs:
           fi
           echo "HOF_SHA=${SHA}" >> $GITHUB_ENV
           echo "HOF_TAG=${TAG}" >> $GITHUB_ENV
-      - name: Setup
+      - name: Fetch Go deps
+        run: go mod download
+      - name: Build hof
         run: go install ./cmd/hof
+      - name: Setup
+        run: |-
+          hof fmt start [email protected]
+          cd docs
+          hof mod link
+          make deps
+      - name: Build
+        run: |-
+          cd docs
+          make gen
+          make hugo.next
+      - name: GCloud Auth
+        uses: google-github-actions/auth@v1
+        with:
+          credentials_json: ${{ secrets.HOF_GCLOUD_JSON }}
+      - name: GCloud Setup
+        uses: google-github-actions/setup-gcloud@v1
+      - name: Docker Auth
+        run: gcloud auth configure-docker
+      - name: Image
+        run: |-
+          cd docs
+          make docker
+          make push
+          make deploy.next.view
     strategy: {}
     services: {}
diff --git a/ci/gha/common/steps.cue b/ci/gha/common/steps.cue
@@ -24,6 +24,21 @@ Steps: {
 		"""
 	}
 
+	cue: {
+		install: {
+			#ver: string | *"v0.5.0-beta.5"
+			run: """
+			mkdir tmp
+			cd tmp
+			wget https://github.com/cue-lang/cue/releases/download/\(#ver)/cue_\(#ver)_linux_amd64.tar.gz -O cue.tar.gz
+			tar -xf cue.tar.gz
+			sudo mv cue /usr/local/bin/cue
+			cd ../
+			rm -rf tmp
+			"""
+		}
+	}
+
 	go: {
 		setup: {
 			#ver: string | *(string & Versions.go)
@@ -110,5 +125,45 @@ Steps: {
 
 		}
 	}
+
+	gcloud: {
+		auth: {
+			name: "GCloud Auth"
+			uses: "google-github-actions/auth@v1"
+			with: credentials_json: "${{ secrets.HOF_GCLOUD_JSON }}"
+		}
+		setup: {
+			name: "GCloud Setup"
+      uses: "google-github-actions/setup-gcloud@v1"
+		}
+
+		dockerAuth: {
+			name: "Docker Auth"
+			run: """
+				gcloud auth configure-docker
+				"""
+		}
+	}
+
+	hof: {
+		install: {
+			name: "Build hof"
+			run:  "go install ./cmd/hof"
+		}
+	}
+
+	docs: {
+
+		setup: {
+			name: "Setup"
+			run:  """
+			hof fmt start [email protected]
+			cd docs
+			hof mod link
+			make deps
+			"""
+		}
+
+	}
 }
 
diff --git a/ci/gha/docs.cue b/ci/gha/docs.cue
@@ -15,44 +15,25 @@ ghacue.#Workflow & {
 	jobs: {
 		docs: {
 			"runs-on": "ubuntu-latest"
-			// environment: "hof docs"
 
 			steps: [
+				// general setup
+				common.Steps.cue.install,
 				common.Steps.go.setup & { #ver: "1.20.x" },
 				common.Steps.go.cache,
 				common.Steps.checkout,
 				common.Steps.vars,
 				common.Steps.go.deps,
-				{
-					name: "Build hof"
-					run:  "go install ./cmd/hof"
-				},
-				{
-					name: "Setup"
-					run:  """
-					cd docs
-					make first 
-					"""
-				},
+				common.Steps.hof.install,
+
+				// dev build site & test
+				common.Steps.docs.setup,
 				{
 					name: "Test"
 					run:  """
 					cd docs
+					make gen
 					make test
-					"""
-				},
-				{
-					name: "Build"
-					run:  """
-					cd docs
-					make build
-					"""
-				},
-
-				{
-					name: "Check"
-					run:  """
-					cd docs
 					make run &
 					make broken-link
 					"""
@@ -61,4 +42,3 @@ ghacue.#Workflow & {
 		}
 	}
 }
-
diff --git a/ci/gha/release-docs.cue b/ci/gha/release-docs.cue
@@ -8,23 +8,65 @@ import (
 ghacue.#Workflow & {
 	name: "release (docs)"
 
-	on: push: {
-		tags: ["docs-*"]
+	on: {
+		push: {
+			tags: ["docs-**"]
+		}
+		workflow_dispatch: {
+			inputs: {
+				deploy: {
+					description: "where to deploy"
+					required: true
+					default: "next"
+					type: "choice"
+					options: ["next", "prod"]
+				}
+			}
+		}
 	}
 
 	jobs: {
 		docs: {
 			"runs-on": "ubuntu-latest"
-			// environment: "hof docs"
+			environment: "hof docs"
 
 			steps: [
+				// general setup
+				common.Steps.cue.install,
+				common.Steps.go.setup & { #ver: "1.20.x" },
+				common.Steps.go.cache,
 				common.Steps.checkout,
 				common.Steps.vars,
+				common.Steps.go.deps,
+				common.Steps.hof.install,
+
+				// prod build site & image
+				common.Steps.docs.setup,
 				{
-					name: "Setup"
-					run:  "go install ./cmd/hof"
+					name: "Build"
+
+					run:  """
+					cd docs
+					make gen
+					make hugo.next
+					"""
 				},
 
+				// gcloud auth setup
+				common.Steps.gcloud.auth,
+				common.Steps.gcloud.setup,
+				common.Steps.gcloud.dockerAuth,
+
+				// push image & deploy
+				{
+					name: "Image"
+					run:  """
+					cd docs
+					make docker
+					make push
+					make deploy.next.view
+					"""
+				},
 			]
 		}
 	}

diff --git a/docs/.gitignore b/docs/.gitignore
@@ -1,7 +1,14 @@
 /dist/
 /resources/
-/code/*.html
+
+# ignore html files generatied from cue files
 /code/**/*.html
+# remember html files we manually write for examples
+!/code/**/templates/*.html
+!/code/**/templates/**/*.html
+!/code/**/partials/*.html
+!/code/**/partials/**/*.html
+
 # /code/flow/examples/
 # /code/flow/schemas/
 /cue.mod/pkg/

diff --git a/docs/Makefile b/docs/Makefile
@@ -1,7 +1,7 @@
 include ./hack/make/*.inc
 
-TAG        = $(shell git rev-parse --short HEAD | tr -d "\n")
-PROJECT    = "hof-io--develop"
+COMMIT  = $(shell git rev-parse --short HEAD | tr -d "\n")
+PROJECT = "hof-io--develop"
 
 help:
 	@cat Makefile
@@ -11,15 +11,13 @@ run: dev
 lint: fmt broken-link
 test: verify
 
-.PHONY: fmt broken-link code highlight
+.PHONY: fmt broken-link highlight
 fmt: cuefmt gofmt
 broken-link: blc.dev
-examples: gen
 highlight: highlight-cue
 
 # build the world and push to production
-.PHONY: first setup publish
-first: deps setup
-setup: config.yaml extern code highlight
-publish: setup build deploy
+.PHONY: first gen
+first: deps gen
+gen: config.yaml extern examples highlight
 
diff --git a/docs/ci/cuelm.cue b/docs/ci/cuelm.cue
@@ -20,7 +20,7 @@ Update: schema.#List & {
 
 #Site: {
 	_Values: {
-		name: "hof-docs"
+		name: string | *"hof-docs" @tag(name)
 		namespace: "websites"
 
 		registry: "us.gcr.io/hof-io--develop"

diff --git a/docs/code/Makefile b/docs/code/Makefile
@@ -0,0 +1,5 @@
+gen:
+	make -C first-example gen
+
+test:
+	make -C first-example test
diff --git a/docs/code/cmd-help/hof b/docs/code/cmd-help/hof
@@ -11,7 +11,7 @@ Main commands:
   gen                   modular and composable code gen: CUE & data + templates = _
   flow                  run CUE pipelines with the hof/flow DAG engine
   fmt                   format any code and manage the formatters
-  mod                   go style dependency management for CUE
+  mod                   CUE dependency management based on Go mods
 
 Additional commands:
   help                  help about any command