From 49045ddc8f9cbe3eb323b26f442c83733f665f67 Mon Sep 17 00:00:00 2001
From: Tom Morelly <tom-morelly@gmx.de>
Date: Tue, 24 Oct 2023 13:31:07 +0200
Subject: [PATCH] docs(gitlab): Add Gitlab CI Examples

---
 site/docs/index.md               |   8 +++
 site/docs/integrations/gitlab.md | 117 +++++++++++++++++++++++++++++++
 site/mkdocs.yml                  |   2 +
 3 files changed, 127 insertions(+)
 create mode 100644 site/docs/integrations/gitlab.md

diff --git a/site/docs/index.md b/site/docs/index.md
index c1f3f5d..069819b 100644
--- a/site/docs/index.md
+++ b/site/docs/index.md
@@ -32,11 +32,19 @@ curl -L -o tfx.exe "https://github.com/straubt1/tfx/releases/download/${version}
 ```
 
 **Go Installation**
+
 From Go version 1.19, the following is supported. `@latest` can be `@$VERSION`
 ```sh
 go install github.com/straubt1/tfx@latest
 ```
 
+**Container**
+
+`tfx` is also packaged and published as a OCI Container Image in the Github Container Registry:
+```sh
+docker pull ghcr.io/straubt1/tfx:latest 
+```
+
 <!-- ### Commands
 
 * [`tfx workspace`](commands/workspace.md) - Commands to work with Workspaces
diff --git a/site/docs/integrations/gitlab.md b/site/docs/integrations/gitlab.md
new file mode 100644
index 0000000..5920676
--- /dev/null
+++ b/site/docs/integrations/gitlab.md
@@ -0,0 +1,117 @@
+# Gitlab CI
+
+## Module Release
+The following snippet serves as a starting point to release Terraform Modules using `tfx`:
+
+```yaml
+# .gitlab-ci.yml
+variables:
+  # tfx auth
+  TFE_HOSTNAME: ""
+  TFE_ORGANIZATION: ""
+  TFE_TOKEN:  ""
+
+  # module vars
+  MODULE_NAME: aws-s3
+  MODULE_PROVIDER: aws
+
+stages:
+  - release
+
+terraform_module_release:
+  stage: release
+  image:
+    name: ghcr.io/straubt1/tfx:latest
+    entrypoint: [""]
+  script:
+    - tfx registry module show --name "${MODULE_NAME}" --provider "${MODULE_PROVIDER}" || tfx registry module create --name "${MODULE_NAME}" --provider "${MODULE_PROVIDER}"  
+    - |
+      tfx registry module version create \
+        --name "${MODULE_NAME}" \
+        --provider "${MODULE_PROVIDER}" \
+        --version "${CI_COMMIT_TAG#v}" \
+        --directory "${CI_PROJECT_DIR}"
+  rules:
+    - if: $CI_COMMIT_TAG
+```
+
+## Provider Release
+The following snippet serves as a starting point to release Terraform Provider using `tfx`:
+
+```yaml
+# .gitlab-ci.yml
+variables:
+  # tfx auth
+  TFE_HOSTNAME: ""
+  TFE_ORGANIZATION: ""
+  TFE_TOKEN:  ""
+
+  # goreleaser vars
+  GITLAB_TOKEN: ""
+  GPG_FINGERPRINT: ""
+
+  # provider vars
+  PROVIDER_NAME: custom-provider
+
+stages:
+  - release
+  - publish
+
+# most likely you  will call goreleaser before publishing
+goreleaser:
+  stage: release
+  image:
+    name: goreleaser/goreleaser:latest
+    entrypoint: [""]
+  script:
+    - goreleaser release
+  artifacts:
+    paths:
+      - ${CI_PROJECT_DIR}/dist
+  rules:
+    - if: $CI_COMMIT_TAG
+
+version:
+  stage: publish
+  image:
+    name: ghcr.io/straubt1/tfx:latest
+    entrypoint: [""]
+  needs:
+    - job: goreleaser_release
+      artifacts: true
+  script:
+    - tfx registry provider version create \
+        --name="${PROVIDER_NAME}" \
+        --version="${CI_COMMIT_TAG#v}" \
+        --key-id="${GPG_FINGERPRINT}" \
+        --shasums="${CI_PROJECT_DIR}/dist/terraform-provider-${PROVIDER_NAME}_${CI_COMMIT_TAG#v}_SHA256SUMS" \
+        --shasums-sig="${CI_PROJECT_DIR}/dist/terraform-provider-${PROVIDER_NAME}_${CI_COMMIT_TAG#v}_SHA256SUMS.sig"
+  rules:
+    - if: $CI_COMMIT_TAG
+   
+platforms:
+  stage: publish
+  image:
+    name: ghcr.io/straubt1/tfx:latest
+    entrypoint: [""]
+  needs:
+    - version
+  parallel:
+    matrix:
+      PLATFORMS:
+        - OS: linux
+          ARCH: amd64
+        - OS: darwin
+          ARCH: arm64
+        - OS: windows
+          ARCH: amd64
+  script:
+    - tfx registry provider version platform create \
+        --name="${PROVIDER_NAME}" \
+        --version="${CI_COMMIT_TAG#v}" \
+        --os="${OS}" \
+        --arch="${ARCH}" \
+        -f="${CI_PROJECT_DIR}/dist/terraform-provider-${PROVIDER_NAME}_${CI_COMMIT_TAG#v}_${OS}_${ARCH}.zip";
+  rules:
+    - if: $CI_COMMIT_TAG
+```
diff --git a/site/mkdocs.yml b/site/mkdocs.yml
index 0100db4..42e422d 100644
--- a/site/mkdocs.yml
+++ b/site/mkdocs.yml
@@ -62,6 +62,8 @@ nav:
     - Admin:
       - GPG Keys: commands/admin_gpg.md
       - Terraform Versions: commands/admin_terraformversion.md
+  - Integrations:
+      - Gitlab CI: integrations/gitlab.md
   - About:
     - Why TFx?: about/purpose.md
     - Release Notes: about/release_notes.md