Publish doc for every release + validate doc on PR (#386)

thomaspoignant · Oct 27, 2022 · 7e2be76 · 7e2be76
1 parent 72f0dc7
commit 7e2be76
Show file tree

Hide file tree

Showing 15 changed files with 83 additions and 71 deletions.
diff --git a/.github/workflows/doc.yml → .github/workflows/doc-deploy.yml b/.github/workflows/doc.yml → .github/workflows/doc-deploy.yml
@@ -1,29 +1,22 @@
-name: Deploy to GitHub Pages
+name: Deploy docs to GitHub Pages
 
 on:
   push:
     branches:
       - main
-    # Review gh actions docs if you want to further define triggers, paths, etc
-    # https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on
 
 jobs:
   deploy:
     name: Deploy to GitHub Pages
     runs-on: ubuntu-latest
-    defaults:
-      run:
-        working-directory: 'docs'
     steps:
       - uses: actions/checkout@v2
       - uses: actions/setup-node@v3
-        with:
-          node-version: 18
-          cache: npm
-
       - name: Install dependencies
+        working-directory: ./docs
         run: npm install
       - name: Build website
+        working-directory: ./docs
         run: npm run build
 
       # Popular action to deploy to GitHub Pages:
@@ -33,4 +26,4 @@ jobs:
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
           # Build output to publish to the `gh-pages` branch:
-          publish_dir: ./build
+          publish_dir: ./docs/build
diff --git a/.github/workflows/doc-test.yml b/.github/workflows/doc-test.yml
@@ -0,0 +1,19 @@
+name: Docs validation
+on:
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  test-deploy:
+    name: Test deployment
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v3
+      - name: Install dependencies
+        working-directory: ./docs
+        run: npm install
+      - name: Test Build website
+        working-directory: ./docs
+        run: npm run build
diff --git a/docs/docs/flag_file/index.md b/docs/docs/flag_file/index.md
@@ -2,12 +2,12 @@
 The module supports different ways of retrieving the flag file.  
 Available retriever are:
 
-- [S3 Bucket](s3)
-- [HTTP endpoint](http)
-- [Github](github)
-- [File](file)
-- [Kubernetes configmap](kubernetes_configmaps)
-- [Google Cloud storage](google_cloud_storage)
+- [S3 Bucket](./s3.md)
+- [HTTP endpoint](./http.md)
+- [Github](./github.md)
+- [File](./file.md)
+- [Kubernetes configmap](./kubernetes_configmaps.md)
+- [Google Cloud storage](./google_cloud_storage.md)
 
 To retrieve a file you need to provide a [retriever](https://pkg.go.dev/github.com/thomaspoignant/go-feature-flag/retriever/#Retriever) in your `ffclient.Config{}` during the initialization.  
 If the existing retriever does not work with your system you can extend the system and use a [custom retriever](custom.md).
diff --git a/docs/versioned_docs/version-v0.17.3/flag_file/index.md b/docs/versioned_docs/version-v0.17.3/flag_file/index.md
@@ -2,9 +2,9 @@
 The module supports different ways of retrieving the flag file.  
 Available retriever are:
 
-- [S3 Bucket](s3)
-- [HTTP endpoint](http)
-- [Github](github)
-- [File](file)
+- [S3 Bucket](./s3.md)
+- [HTTP endpoint](./http.md)
+- [Github](./github.md)
+- [File](./file.md)
 
 To retrieve a file you need to provide a [retriever](https://pkg.go.dev/github.com/thomaspoignant/go-feature-flag#Retriever) in your `ffclient.Config{}` during the initialization.
diff --git a/docs/versioned_docs/version-v0.18.6/flag_file/index.md b/docs/versioned_docs/version-v0.18.6/flag_file/index.md
@@ -2,10 +2,10 @@
 The module supports different ways of retrieving the flag file.  
 Available retriever are:
 
-- [S3 Bucket](s3)
-- [HTTP endpoint](http)
-- [Github](github)
-- [File](file)
+- [S3 Bucket](./s3.md)
+- [HTTP endpoint](./http.md)
+- [Github](./github.md)
+- [File](./file.md)
 
 To retrieve a file you need to provide a [retriever](https://pkg.go.dev/github.com/thomaspoignant/go-feature-flag#Retriever) in your `ffclient.Config{}` during the initialization.  
 If the existing retriever does not work with your system you can extend the system and use a [custom retriever](custom.md).
diff --git a/docs/versioned_docs/version-v0.19.5/flag_file/index.md b/docs/versioned_docs/version-v0.19.5/flag_file/index.md
@@ -2,10 +2,10 @@
 The module supports different ways of retrieving the flag file.  
 Available retriever are:
 
-- [S3 Bucket](s3)
-- [HTTP endpoint](http)
-- [Github](github)
-- [File](file)
+- [S3 Bucket](./s3.md)
+- [HTTP endpoint](./http.md)
+- [Github](./github.md)
+- [File](./file.md)
 
 To retrieve a file you need to provide a [retriever](https://pkg.go.dev/github.com/thomaspoignant/go-feature-flag#Retriever) in your `ffclient.Config{}` during the initialization.  
 If the existing retriever does not work with your system you can extend the system and use a [custom retriever](custom.md).
diff --git a/docs/versioned_docs/version-v0.20.0/flag_file/index.md b/docs/versioned_docs/version-v0.20.0/flag_file/index.md
@@ -2,10 +2,10 @@
 The module supports different ways of retrieving the flag file.  
 Available retriever are:
 
-- [S3 Bucket](s3)
-- [HTTP endpoint](http)
-- [Github](github)
-- [File](file)
+- [S3 Bucket](./s3.md)
+- [HTTP endpoint](./http.md)
+- [Github](./github.md)
+- [File](./file.md)
 
 To retrieve a file you need to provide a [retriever](https://pkg.go.dev/github.com/thomaspoignant/go-feature-flag#Retriever) in your `ffclient.Config{}` during the initialization.  
 If the existing retriever does not work with your system you can extend the system and use a [custom retriever](custom.md).
diff --git a/docs/versioned_docs/version-v0.21.0/flag_file/index.md b/docs/versioned_docs/version-v0.21.0/flag_file/index.md
@@ -2,10 +2,10 @@
 The module supports different ways of retrieving the flag file.  
 Available retriever are:
 
-- [S3 Bucket](s3)
-- [HTTP endpoint](http)
-- [Github](github)
-- [File](file)
+- [S3 Bucket](./s3.md)
+- [HTTP endpoint](./http.md)
+- [Github](./github.md)
+- [File](./file.md)
 
 To retrieve a file you need to provide a [retriever](https://pkg.go.dev/github.com/thomaspoignant/go-feature-flag#Retriever) in your `ffclient.Config{}` during the initialization.  
 If the existing retriever does not work with your system you can extend the system and use a [custom retriever](custom.md).
diff --git a/docs/versioned_docs/version-v0.22.3/flag_file/index.md b/docs/versioned_docs/version-v0.22.3/flag_file/index.md
@@ -2,10 +2,10 @@
 The module supports different ways of retrieving the flag file.  
 Available retriever are:
 
-- [S3 Bucket](s3)
-- [HTTP endpoint](http)
-- [Github](github)
-- [File](file)
+- [S3 Bucket](./s3.md)
+- [HTTP endpoint](./http.md)
+- [Github](./github.md)
+- [File](./file.md)
 
 To retrieve a file you need to provide a [retriever](https://pkg.go.dev/github.com/thomaspoignant/go-feature-flag#Retriever) in your `ffclient.Config{}` during the initialization.  
 If the existing retriever does not work with your system you can extend the system and use a [custom retriever](custom.md).
diff --git a/docs/versioned_docs/version-v0.23.0/flag_file/index.md b/docs/versioned_docs/version-v0.23.0/flag_file/index.md
@@ -2,10 +2,10 @@
 The module supports different ways of retrieving the flag file.  
 Available retriever are:
 
-- [S3 Bucket](s3)
-- [HTTP endpoint](http)
-- [Github](github)
-- [File](file)
+- [S3 Bucket](./s3.md)
+- [HTTP endpoint](./http.md)
+- [Github](./github.md)
+- [File](./file.md)
 
 To retrieve a file you need to provide a [retriever](https://pkg.go.dev/github.com/thomaspoignant/go-feature-flag#Retriever) in your `ffclient.Config{}` during the initialization.  
 If the existing retriever does not work with your system you can extend the system and use a [custom retriever](custom.md).
diff --git a/docs/versioned_docs/version-v0.24.0/flag_file/index.md b/docs/versioned_docs/version-v0.24.0/flag_file/index.md
@@ -2,10 +2,10 @@
 The module supports different ways of retrieving the flag file.  
 Available retriever are:
 
-- [S3 Bucket](s3)
-- [HTTP endpoint](http)
-- [Github](github)
-- [File](file)
+- [S3 Bucket](./s3.md)
+- [HTTP endpoint](./http.md)
+- [Github](./github.md)
+- [File](./file.md)
 
 To retrieve a file you need to provide a [retriever](https://pkg.go.dev/github.com/thomaspoignant/go-feature-flag#Retriever) in your `ffclient.Config{}` during the initialization.  
 If the existing retriever does not work with your system you can extend the system and use a [custom retriever](custom.md).
diff --git a/docs/versioned_docs/version-v0.25.2/flag_file/index.md b/docs/versioned_docs/version-v0.25.2/flag_file/index.md
@@ -2,10 +2,10 @@
 The module supports different ways of retrieving the flag file.  
 Available retriever are:
 
-- [S3 Bucket](s3)
-- [HTTP endpoint](http)
-- [Github](github)
-- [File](file)
+- [S3 Bucket](./s3.md)
+- [HTTP endpoint](./http.md)
+- [Github](./github.md)
+- [File](./file.md)
 
 To retrieve a file you need to provide a [retriever](https://pkg.go.dev/github.com/thomaspoignant/go-feature-flag#Retriever) in your `ffclient.Config{}` during the initialization.  
 If the existing retriever does not work with your system you can extend the system and use a [custom retriever](custom.md).
diff --git a/docs/versioned_docs/version-v0.26.1/flag_file/index.md b/docs/versioned_docs/version-v0.26.1/flag_file/index.md
@@ -2,12 +2,12 @@
 The module supports different ways of retrieving the flag file.  
 Available retriever are:
 
-- [S3 Bucket](s3)
-- [HTTP endpoint](http)
-- [Github](github)
-- [File](file)
-- [Kubernetes configmap](kubernetes_configmaps)
-- [Google Cloud storage](google_cloud_storage)
+- [S3 Bucket](./s3.md)
+- [HTTP endpoint](./http.md)
+- [Github](./github.md)
+- [File](./file.md)
+- [Kubernetes configmap](./kubernetes_configmaps.md)
+- [Google Cloud storage](./google_cloud_storage.md)
 
 To retrieve a file you need to provide a [retriever](https://pkg.go.dev/github.com/thomaspoignant/go-feature-flag/retriever/#Retriever) in your `ffclient.Config{}` during the initialization.  
 If the existing retriever does not work with your system you can extend the system and use a [custom retriever](custom.md).
diff --git a/docs/versioned_docs/version-v0.27.2/flag_file/index.md b/docs/versioned_docs/version-v0.27.2/flag_file/index.md
@@ -2,12 +2,12 @@
 The module supports different ways of retrieving the flag file.  
 Available retriever are:
 
-- [S3 Bucket](s3)
-- [HTTP endpoint](http)
-- [Github](github)
-- [File](file)
-- [Kubernetes configmap](kubernetes_configmaps)
-- [Google Cloud storage](google_cloud_storage)
+- [S3 Bucket](./s3.md)
+- [HTTP endpoint](./http.md)
+- [Github](./github.md)
+- [File](./file.md)
+- [Kubernetes configmap](./kubernetes_configmaps.md)
+- [Google Cloud storage](./google_cloud_storage.md)
 
 To retrieve a file you need to provide a [retriever](https://pkg.go.dev/github.com/thomaspoignant/go-feature-flag/retriever/#Retriever) in your `ffclient.Config{}` during the initialization.  
 If the existing retriever does not work with your system you can extend the system and use a [custom retriever](custom.md).
diff --git a/docs/versioned_docs/version-v0.28.1/flag_file/index.md b/docs/versioned_docs/version-v0.28.1/flag_file/index.md
@@ -2,12 +2,12 @@
 The module supports different ways of retrieving the flag file.  
 Available retriever are:
 
-- [S3 Bucket](s3)
-- [HTTP endpoint](http)
-- [Github](github)
-- [File](file)
-- [Kubernetes configmap](kubernetes_configmaps)
-- [Google Cloud storage](google_cloud_storage)
+- [S3 Bucket](./s3.md)
+- [HTTP endpoint](./http.md)
+- [Github](./github.md)
+- [File](./file.md)
+- [Kubernetes configmap](./kubernetes_configmaps.md)
+- [Google Cloud storage](./google_cloud_storage.md)
 
 To retrieve a file you need to provide a [retriever](https://pkg.go.dev/github.com/thomaspoignant/go-feature-flag/retriever/#Retriever) in your `ffclient.Config{}` during the initialization.  
 If the existing retriever does not work with your system you can extend the system and use a [custom retriever](custom.md).