Documentation 0.5.0

.github/scripts/doc-build.sh

@@ -0,0 +1,28 @@
+#!/bin/bash
+
+set -e 
+
+DOC_TEMPLATE_SUBMODULE="docs/doc-terraform-template"
+
+if [ "$TAG" == "" ]; then
+    echo "We need the tag of the doc"
+    exit 1
+fi
+
+# Create a branch
+git checkout -b "autobuild-Documentation-$TAG"
+
+# Update submodule
+(cd $DOC_TEMPLATE_SUBMODULE && git fetch && git checkout $TAG)
+
+# Gen the doc
+make doc
+
+# Create PR
+git config user.name "Outscale Bot"
+git config user.email "[email protected]"
+
+git add $DOC_TEMPLATE_SUBMODULE
+git add website/*
+
+git commit -sm "Release Documentation $TAG"

.github/scripts/doc-pr.sh

@@ -0,0 +1,19 @@
+#!/bin/env bash
+set -e
+
+if [ -z "$GH_BOT_TOKEN" ]; then
+    echo "GH_BOT_TOKEN is missing, abort."
+    exit 1
+fi
+
+# https://docs.github.com/en/free-pro-team@latest/rest/reference/pulls#create-a-pull-request
+result=$(curl -s -X POST -H "Authorization: token $GH_BOT_TOKEN" -d "{\"head\":\"autobuild-Documentation-$TAG\",\"base\":\"master\",\"title\":\"Documentation $TAG\",\"body\":\"Automatic generation of the documentation $TAG\"}" "https://api.github.com/repos/outscale-mdr/terraform-provider-outscale/pulls")
+
+errors=$(echo $result | jq .errors)
+
+echo $errors
+
+if [ "$errors" != "null" ]; then
+    echo "errors while creating pull request, abort."
+    exit 1
+fi

.github/scripts/doc-push.sh

@@ -0,0 +1,17 @@
+#!/bin/bash
+
+set -e 
+
+if [ "$TAG" == "" ]; then
+    echo "We need the tag of the doc"
+    exit 1
+fi
+
+if [ "$SSH_PRIVATE_KEY" == "" ]; then
+    echo "We need the SSH key of the bot"
+    exit 1   
+fi
+
+echo "$SSH_PRIVATE_KEY" > bot.key
+chmod 600 bot.key
+GIT_SSH_COMMAND="ssh -i bot.key" git push -f origin "autobuild-Documentation-$TAG"

.github/workflows/generate_doc.yml

@@ -0,0 +1,31 @@
+name: Generate documentation
+on:
+  workflow_dispatch:
+    inputs:
+      tag:
+        description: 'doc template tag repository'
+        required: true
+
+jobs:
+  doc-release:
+    environment: auto-build
+    runs-on: ubuntu-20.04
+    steps:
+      - uses: actions/checkout@v2
+        with: 
+         submodules: 'recursive'
+      - uses: actions/setup-python@v2
+      - name: auto-generate release
+        run: .github/scripts/doc-build.sh
+        env:
+          TAG: ${{ github.event.inputs.tag }}
+      - name: push release branch
+        run: .github/scripts/doc-push.sh
+        env:
+          SSH_PRIVATE_KEY: ${{ secrets.SSH_PRIVATE_KEY }}
+          TAG: ${{ github.event.inputs.tag }}
+      - name: create pull request
+        run: .github/scripts/doc-pr.sh
+        env:
+          TAG: ${{ github.event.inputs.tag }}
+          GH_BOT_TOKEN: ${{ secrets.GH_BOT_TOKEN }}

.gitignore

@@ -32,4 +32,8 @@ terraformStatePull.json
 /tests/resources.auto.tfvars.template.cpgz
 /tests/test.tf
 /tests/old.py
-/tests/tmp.txt
+/tests/tmp.txt
+
+# docs
+docs/generation_log.txt
+docs/.venv

.gitmodules

@@ -0,0 +1,6 @@
+[submodule "docs/osc-api"]
+	path = docs/osc-api
+	url = https://github.com/outscale/osc-api
+[submodule "docs/doc-terraform-template"]
+	path = docs/doc-terraform-template
+	url = https://github.com/outscale-dev/terraform-provider-outscale-doc-components.git

GNUmakefile

@@ -78,4 +78,7 @@ examples-test:
 		cd ../..; \
 	done\
 
+doc:
+	@sh -c "'$(CURDIR)/scripts/generate-doc.sh'"
+
 .PHONY: build test testacc fmt fmtcheck lint tools test-compile website website-lint website-test examples-test website-local

README.md

@@ -113,3 +113,14 @@ Issues and contributions
 ------------------------
 
 Check [CONTRIBUTING.md](./CONTRIBUTING.md) for more details.
+
+
+Building the documentation
+------------------------
+- Requirements:
+  - make
+  - python3
+  - python-venv
+```shell
+  $ make doc
+```