Generate specific Registry Documentation format by Release (#58)

Author: nolte

.github/boring-cyborg.yml

@@ -6,7 +6,7 @@ labelPRBasedOnFilePath:
   chore:
     - .github/**
   documentations:
-    - docs/**
+    - documentation/**
     - mkdocs.yml
     - .github/ISSUE_TEMPLATE/**
-    - .github/pull_request_template.md
+    - .github/pull_request_template.md

.github/pull_request_template.md

@@ -11,7 +11,7 @@ More informations about the Documentation process can be found at
 https://nolte.github.io/terraform-provider-harbor/guides/development/#docs
 --->
 ### Documentation
-- [ ] Have you create or updated the provider documentation at ``./docs``?
+- [ ] Have you create or updated the provider documentation at ``./documentation/provider_doc``?
   - [ ] If **new** resources or datasource documentation happen, did you add this to the `mkdocs.yml` configuration?
 
 ### References

.github/workflows/cicd-docs.yml

@@ -0,0 +1,40 @@
+name: Release Flow
+
+on:
+  push:
+    branches:
+      - "**"
+jobs:
+  docs:
+    name: Publish the HTML Documentation
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout master
+        uses: actions/checkout@v1
+      - name: Set up Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: "3.8"
+      - name: Set up Go 1.x
+        uses: actions/setup-go@v2
+        with:
+          go-version: ^1.14
+        id: go
+
+      - uses: actions/cache@v2
+        with:
+          path: ~/go/pkg/mod
+          key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
+          restore-keys: |
+            ${{ runner.os }}-go-
+      - name: Install dependencies
+        run: |
+           python -m pip install --upgrade pip
+           pip install MarkdownPP mkdocs
+      - name: Install dependencies
+        run: |
+          cd ./documentation && go run mage.go -v GenerateDocumation
+      #- name: Deploy docs
+      #  uses: mhausenblas/mkdocs-deploy-gh-pages@master
+      #  env:
+      #    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/cicd-release.yml

@@ -9,7 +9,43 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout master
-        uses: actions/checkout@v1
+        uses: actions/[email protected]
+      - name: Set up Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: "3.8"
+      - name: Set up Go 1.x
+        uses: actions/setup-go@v2
+        with:
+          go-version: ^1.14
+        id: go
+
+      - uses: actions/cache@v2
+        with:
+          path: ~/go/pkg/mod
+          key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
+          restore-keys: |
+            ${{ runner.os }}-go-
+
+      - name: Install dependencies
+        run: |
+           python -m pip install --upgrade pip
+           pip install MarkdownPP mkdocs
+      - name: Install dependencies
+        run: |
+          cd ./documentation && go run mage.go -v GenerateDocumation
+      - uses: EndBug/add-and-commit@v4 # You can change this to use a specific version
+        with:
+          add: 'docs'
+          force: true
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      - uses: EndBug/add-and-commit@v4 # You can change this to use a specific version
+        with:
+          add: 'documentation/provider_doc'
+          force: true
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
       - name: Deploy docs
         uses: mhausenblas/mkdocs-deploy-gh-pages@master

.gitignore

@@ -2,6 +2,7 @@ terraform-provider-harbor_*
 gen
 bin
 dist
+docs
 
 # Local .terraform directories
 **/.terraform/*

docs/adr/0000-use-markdown-architectural-decision-records.md renamed to documentation/adr/0000-use-markdown-architectural-decision-records.md

@@ -0,0 +1,8 @@
+module main
+
+go 1.14
+
+require (
+	github.com/magefile/mage v1.10.0
+	github.com/otiai10/copy v1.2.0
+)