kptdev
diff --git a/‎.github/hooks/pre-commit
Lines changed: 14 additions & 0 deletions b/‎.github/hooks/pre-commit
Lines changed: 14 additions & 0 deletions
diff --git a/‎.github/workflows/checkSite.yml
Lines changed: 44 additions & 0 deletions b/‎.github/workflows/checkSite.yml
Lines changed: 44 additions & 0 deletions
diff --git a/‎.github/workflows/ci.yaml
Lines changed: 11 additions & 27 deletions b/‎.github/workflows/ci.yaml
Lines changed: 11 additions & 27 deletions
diff --git a/‎.github/workflows/firebase-hosting-merge.yml
Lines changed: 27 additions & 0 deletions b/‎.github/workflows/firebase-hosting-merge.yml
Lines changed: 27 additions & 0 deletions
diff --git a/‎.github/workflows/verify-docs.yaml
Lines changed: 32 additions & 0 deletions b/‎.github/workflows/verify-docs.yaml
Lines changed: 32 additions & 0 deletions
diff --git a/‎.gitignore
Lines changed: 1 addition & 0 deletions b/‎.gitignore
Lines changed: 1 addition & 0 deletions
diff --git a/‎Makefile
Lines changed: 10 additions & 2 deletions b/‎Makefile
Lines changed: 10 additions & 2 deletions
diff --git a/‎README.md
Lines changed: 3 additions & 0 deletions b/‎README.md
Lines changed: 3 additions & 0 deletions
diff --git a/‎examples/_template/README.md
Lines changed: 5 additions & 5 deletions b/‎examples/_template/README.md
Lines changed: 5 additions & 5 deletions
diff --git a/‎examples/apply-setters/simple/.expected/diff.patch
Lines changed: 4 additions & 4 deletions b/‎examples/apply-setters/simple/.expected/diff.patch
Lines changed: 4 additions & 4 deletions
@@ -0,0 +1,14 @@
+#!/bin/bash
+
+cd functions/go;
+echo "Generating docs..."
+make generate;
+diff=`git diff`
+
+if [[ $diff != "" ]];
+then 
+        echo "found unstaged changes. Please ensure you have run `make generate` to update the generated docs and add them before commit."
+        exit 1
+else 
+        exit 0
+fi
@@ -0,0 +1,44 @@
+# Copyright 2021 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+name: CheckSite
+on:
+  pull_request:
+    paths:
+      - "functions/**"
+      - "examples/**"
+      - "site/**"
+      - "scripts/generate_catalog/**"
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+      - uses: actions/checkout@v2
+        with:
+          repository: etefera/href-checker
+          ref: docsify
+          path: href-checker
+      - uses: actions/setup-node@v2
+        with:
+          node-version: '14'
+      - name: Install Site Checker
+        run: yarn install
+        working-directory: href-checker
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v1
+      - name: Run Site Checker
+        run: make site-check
@@ -67,50 +67,34 @@ jobs:
         cd functions/go
         make check-licenses
 
-  verify-ci:
-    runs-on: ubuntu-latest
-    env:
-      GOPATH: /home/runner/work/kpt-functions-catalog/functions/go
-      GO111MODULE: on
-    steps:
-    - uses: actions/checkout@v2
-    - name: Set up python 3
-      uses: actions/setup-python@v2
-    - name: Install libs
-      run: |
-        pip install pyyaml
-    - name: Set up Go 1.15
-      uses: actions/setup-go@v2
-      with:
-        go-version: 1.15
-    - name: Install mdrip
-      run: |
-        go get github.com/russross/blackfriday/v2@v2.0.1
-        go get github.com/monopole/mdrip@v1.0.2
-    - name: Verify docs
-      run: |
-        make verify-docs
-
   e2e-ci:
-    needs: [ts-unit-test-ci, go-unit-test-ci, verify-ci]
+    needs: [ts-unit-test-ci, go-unit-test-ci]
     strategy:
       matrix:
         platform: [ubuntu-latest]
         node-version: [12.x]
     runs-on: ${{ matrix.platform }}
+    env:
+      GOPATH: /home/runner/work/kpt-functions-catalog/functions/go
+      GO111MODULE: on
     steps:
     - uses: actions/checkout@v2
     - name: Use Node.js ${{ matrix.node-version }}
       uses: actions/setup-node@v1
       with:
         node-version: ${{ matrix.node-version }}
+    - name: Set up Go 1.15
+      uses: actions/setup-go@v2
+      with:
+        go-version: 1.15
+    - name: Install kpt
+      run: |
+        go get github.com/GoogleContainerTools/kpt@next
     - name: Build node and Go docker images
       if: matrix.platform == 'ubuntu-latest'
       run: |
         make build
     - name: Run all tests
       if: matrix.platform == 'ubuntu-latest'
       run: |
-        sudo curl https://storage.googleapis.com/kpt-dev/latest/linux_amd64/kpt -o /usr/local/bin/kpt
-        sudo chmod +x /usr/local/bin/kpt
         make e2e-test
@@ -0,0 +1,27 @@
+# This file was initially auto-generated by the Firebase CLI
+# https://github.com/firebase/firebase-tools
+
+name: Deploy to Firebase Hosting on merge
+on: 
+ push:
+    branches:
+      - master
+      - "*/v[0-9]+.[0-9]+"
+jobs:
+  build_and_deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+      - name: Generate Site
+        run: make site-generate
+      - uses: FirebaseExtended/action-hosting-deploy@276388dd6c2cde23455b30293105cc866c22282d # v0
+        with:
+          repoToken: '${{ secrets.GITHUB_TOKEN }}'
+          firebaseServiceAccount: '${{ secrets.FIREBASE_SERVICE_ACCOUNT_KPT_DEV }}'
+          channelId: live
+          projectId: kpt-dev
+          entryPoint: site
+        env:
+          FIREBASE_CLI_PREVIEWS: hostingchannels
@@ -0,0 +1,32 @@
+name: verify-docs
+
+on:
+  pull_request:
+    branches:
+      - master
+      - '*/v[0-9]+.[0-9]+'
+
+jobs:
+  verify-ci:
+    runs-on: ubuntu-latest
+    env:
+      GOPATH: /home/runner/work/kpt-functions-catalog/functions/go
+      GO111MODULE: on
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up python 3
+      uses: actions/setup-python@v2
+    - name: Install libs
+      run: |
+        pip install pyyaml
+    - name: Set up Go 1.15
+      uses: actions/setup-go@v2
+      with:
+        go-version: 1.15
+    - name: Install mdrip
+      run: |
+        go get github.com/russross/blackfriday/v2@v2.0.1
+        go get github.com/monopole/mdrip@v1.0.2
+    - name: Verify docs
+      run: |
+        make verify-docs
@@ -1,4 +1,5 @@
 .idea
+.vscode
 dist
 node_modules
 *.iml
 
@@ -55,6 +55,14 @@ push: ## Push images to registry. WARN: This operation should only be done in CI
 	cd functions/contrib/ts && $(MAKE) push
 
 site-generate: ## Collect function branches and generate a catalog of their examples and documentation using kpt next.
-	rm -rf ./examples/*/
+	rm -rf ./site/*/
 	# GO111MODULE=on go get -v github.com/GoogleContainerTools/kpt@next
-	(cd scripts/generate_catalog/ && go run . ../.. ../../examples)
+	(cd scripts/generate_catalog/ && go run . ../.. ../../site)
+
+site-run: ## Run the site locally.
+	make site-generate
+	./scripts/run-site.sh
+
+site-check: ## Test site for broken catalog links.
+	make site-run
+	./scripts/check-site.sh
@@ -4,6 +4,8 @@
 
 [Documentation]
 
+[Open an Issue]
+
 [Contributor Guide]
 
 [Release Process]
@@ -14,3 +16,4 @@
 [Contributor Guide]: CONTRIBUTING.md
 [Code of Conduct]: CODE_OF_CONDUCT.md
 [Release Process]: RELEASING.md
+[Open an Issue]: https://github.com/GoogleContainerTools/kpt/issues
@@ -1,6 +1,6 @@
 # some-image-foo: Example Title
 
-## Overview
+### Overview
 
 1. Explain what this particular example demonstrates.
 2. Include a link to the function reference (help doc) on first mention of the function.
@@ -9,15 +9,15 @@
     1. Explain what this function config does.
     Focus on explaining this particular example, not repeating the function reference.
 
-## Function invocation
+### Function invocation
 
 4. Show exact `kpt` commands to get the example package and run the function.
 
-## Expected result
+### Expected result
 
 5. Describe the expected outcome of running the instructions above. This needs to be specific enough
  so that the user is confident the function works as expected (Don't just provide the command to `cat` a file).
 
-## Function Reference
+### Function Reference
 
-6. Provide a link to the function help doc for reference.
+6. Provide a link to the function help doc for reference.
@@ -1,5 +1,5 @@
 diff --git a/resources.yaml b/resources.yaml
-index c0c871e..cd75f56 100644
+index c79db4d..6dc582c 100644
 --- a/resources.yaml
 +++ b/resources.yaml
@@ -1,7 +1,7 @@
@@ -15,6 +15,6 @@ index c0c871e..cd75f56 100644
  metadata:
    name: ns
  environments: # kpt-set: ${env}
--- dev
-+- prod
- - stage
+-  - dev
++  - prod
+   - stage
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`.idea`
	`2`	`+.vscode`
`2`	`3`	`dist`
`3`	`4`	`node_modules`
`4`	`5`	`*.iml`