Enable site deploy preview for pull requests

Signed-off-by: Khosrow Moossavi <khos2ow@gmail.com>
This commit is contained in:
Khosrow Moossavi
2021-03-02 17:23:45 -05:00
parent 124aa37559
commit 2b150c1876
5 changed files with 43 additions and 7 deletions

View File

@@ -111,16 +111,13 @@ jobs:
- name: Prepare docs - name: Prepare docs
if: contains(github.ref, 'refs/heads/master') if: contains(github.ref, 'refs/heads/master')
run: | run: ./scripts/docs/prepare-site.sh
git clone -b main https://github.com/terraform-docs/website scripts/docs/website
rm -rf scripts/docs/website/content/
cp -r docs/ scripts/docs/website/content/
- name: Publish to website - name: Publish to website
uses: drud/action-cross-commit@master uses: drud/action-cross-commit@master
if: contains(github.ref, 'refs/heads/master') if: contains(github.ref, 'refs/heads/master')
with: with:
source-folder: scripts/docs/website/content source-folder: site/content
destination-repository: https://${{ secrets.COMMITTER_USERNAME }}:${{ secrets.COMMITTER_TOKEN }}@github.com/terraform-docs/website destination-repository: https://${{ secrets.COMMITTER_USERNAME }}:${{ secrets.COMMITTER_TOKEN }}@github.com/terraform-docs/website
destination-folder: content destination-folder: content
destination-branch: main destination-branch: main

3
.gitignore vendored
View File

@@ -32,3 +32,6 @@ coverage.txt
# goreleaser # goreleaser
dist/ dist/
# website
site/

View File

@@ -1,4 +1,5 @@
--- ---
title : "Generate Terraform module documentation" title : "terraform-docs"
description: "Generate documentation from Terraform modules in various output formats." description: "Generate Terraform modules documentation in various formats."
lead: "Generate Terraform modules documentation in various formats."
--- ---

10
netlify.toml Normal file
View File

@@ -0,0 +1,10 @@
[build]
publish = "site/public"
[build.environment]
HUGO_VERSION = "0.80.0"
NODE_VERSION = "15.5.1"
NPM_VERSION = "7.3.0"
[context.deploy-preview]
command = "./scripts/docs/prepare-site.sh && cd site && npm install && hugo -b ${DEPLOY_PRIME_URL} --gc"

25
scripts/docs/prepare-site.sh Executable file
View File

@@ -0,0 +1,25 @@
#!/usr/bin/env bash
#
# Copyright 2021 The terraform-docs Authors.
#
# Licensed under the MIT license (the "License"); you may not
# use this file except in compliance with the License.
#
# You may obtain a copy of the License at the LICENSE file in
# the root directory of this source tree.
set -o errexit
set -o pipefail
PWD=$(cd "$(dirname "$0")" && pwd -P)
PWD="${PWD}/../.."
# Make sure site/ folder does not exist
rm -rf "${PWD}"/site
# Clone the website repository locally
git clone -b main https://github.com/terraform-docs/website "${PWD}"/site
# Update website content
rm -rf "${PWD}"/site/content/
cp -r "${PWD}"/docs/ "${PWD}"/site/content/