feat: release docs on release and not CI (rjsf-team#2856)

* feat: release docs on release and not CI * docs: explain release docs workflow * docs: update contribute docs * Update contributing.md * Update contributing.md * Update docs/contributing.md Co-authored-by: Ashwin Ramaswami <aramaswamis@gmail.com> * use stable version of docs * chore: revert changes * ci: always remove v from tag * docs: update mui and material-ui * ci: revert docs Co-authored-by: Heath C <51679588+heath-freenome@users.noreply.github.com> Co-authored-by: Nick Grosenbacher <nickgrosenbacher@gmail.com> Co-authored-by: Ashwin Ramaswami <aramaswamis@gmail.com>
mpenndev · Sep 2, 2022 · a2e9478 · a2e9478
1 parent c1f220f
commit a2e9478
Show file tree

Hide file tree

Showing 13 changed files with 81 additions and 15 deletions.
diff --git a/.github/workflows/change-tag-name.yml b/.github/workflows/change-tag-name.yml
@@ -0,0 +1,14 @@
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+  release-on-push:
+    runs-on: ubuntu-latest
+    env:
+      GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+    steps:
+      - uses: rymndhng/release-on-push-action@master
+        with:
+          tag_prefix: ""
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -79,6 +79,16 @@ jobs:
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
+  docs:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+    - name: Setup Python
+      uses: actions/setup-python@v4
+      with:
+        python-version: 3.6
+    - run: pip install -r requirements.docs.txt
+    - run: mkdocs build --clean
   # deploy_canary:
   #   runs-on: ubuntu-latest
   #   if: github.ref == 'refs/heads/master'
@@ -97,14 +107,3 @@ jobs:
   #     - run: npx lerna publish from-package --yes --no-verify-access --canary
   #     - if: always()
   #       run: rm .npmrc
-
-  docs:
-    runs-on: ubuntu-latest
-    steps:
-    - uses: actions/checkout@v3
-    - name: Setup Python
-      uses: actions/setup-python@v4
-      with:
-        python-version: 3.6
-    - run: pip install -r requirements.docs.txt
-    - run: mkdocs build --clean
diff --git a/.github/workflows/release-docs.yml b/.github/workflows/release-docs.yml
@@ -0,0 +1,33 @@
+name: Release Latest Documentation
+
+on:
+  release:
+    types: [published]
+  workflow_dispatch:
+
+jobs:
+  create-tag:
+      runs-on: ubuntu-latest
+      steps:
+        - name: Run find-and-replace to remove v
+          uses: mad9000/actions-find-and-replace-string@2
+          id: tag_without_v
+          with:
+            source: ${{ github.event.release.tag_name }}
+            find: 'v'
+            replace: ''
+        - uses: actions/checkout@v3
+        - uses: rickstaa/action-create-tag@v1
+          with:
+            tag: ${{ steps.tag_without_v.outputs.value }}
+            message: "Tagged documentation release"
+  deploy_docs:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+    - name: Setup Python
+      uses: actions/setup-python@v3
+      with:
+        python-version: 3.6
+    - run: pip install -r requirements.docs.txt
+    - run: mkdocs build --clean
diff --git a/README.md b/README.md
@@ -12,7 +12,7 @@
   <p align="center">
     A simple <a href="http://facebook.github.io/react/">React</a> component capable of using <a href="http://json-schema.org/">JSON Schema</a> to declaratively build and customize web forms.
     <br />
-    <a href="https://react-jsonschema-form.readthedocs.io/en/latest/"><strong>Explore the docs »</strong></a>
+    <a href="https://react-jsonschema-form.readthedocs.io/en/stable/"><strong>Explore the docs »</strong></a>
     <br />
     <br />
     <a href="https://rjsf-team.github.io/react-jsonschema-form/">View Playground</a>

diff --git a/docs/contributing.md b/docs/contributing.md
@@ -69,7 +69,9 @@ is stored as the `NPM_TOKEN` secret on GitHub Actions.
 
 ### Releasing docs
 
-Docs are automatically released using [Read The Docs](https://readthedocs.org/) based on the latest commits from the `master` branch.
+Docs are automatically published using [Read The Docs](https://readthedocs.org/) upon a new Release.
+
+You can also publish the latest release of the docs by running the [Release Latest Documentation](https://docs.github.com/en/actions/managing-workflow-runs/manually-running-a-workflow#running-a-workflow) workflow on GitHub Actions.
 
 ### Releasing the playground
 

diff --git a/packages/antd/README.md b/packages/antd/README.md
@@ -30,7 +30,9 @@
 
 ## Table of Contents
 
+- [Table of Contents](#table-of-contents)
 - [About The Project](#about-the-project)
+  - [Built With](#built-with)
 - [Getting Started](#getting-started)
   - [Prerequisites](#prerequisites)
   - [Installation](#installation)

diff --git a/packages/bootstrap-4/README.md b/packages/bootstrap-4/README.md
@@ -25,7 +25,9 @@
 
 ## Table of Contents
 
+- [Table of Contents](#table-of-contents)
 - [About The Project](#about-the-project)
+  - [Built With](#built-with)
 - [Getting Started](#getting-started)
   - [Prerequisites](#prerequisites)
   - [Installation](#installation)

diff --git a/packages/chakra-ui/README.md b/packages/chakra-ui/README.md
@@ -38,6 +38,8 @@
   - [Prerequisites](#prerequisites)
   - [Installation](#installation)
 - [Usage](#usage)
+- [Optional Chakra UI Theme properties](#optional-chakra-ui-theme-properties)
+    - [Custom Chakra uiSchema Chakra Property](#custom-chakra-uischema-chakra-property)
 - [Roadmap](#roadmap)
 - [Contributing](#contributing)
 - [Contact](#contact)

diff --git a/packages/core/README.md b/packages/core/README.md
@@ -30,7 +30,9 @@
 
 ## Table of Contents
 
+- [Table of Contents](#table-of-contents)
 - [About The Project](#about-the-project)
+  - [Built With](#built-with)
 - [Getting Started](#getting-started)
   - [Prerequisites](#prerequisites)
   - [Installation](#installation)

diff --git a/packages/fluent-ui/README.md b/packages/fluent-ui/README.md
@@ -31,7 +31,9 @@
 
 ## Table of Contents
 
+- [Table of Contents](#table-of-contents)
 - [About The Project](#about-the-project)
+  - [Built With](#built-with)
 - [Getting Started](#getting-started)
   - [Prerequisites](#prerequisites)
   - [Installation](#installation)

diff --git a/packages/material-ui/README.md b/packages/material-ui/README.md
@@ -30,8 +30,9 @@
 <!-- TABLE OF CONTENTS -->
 
 ## Table of Contents
-
+- [Table of Contents](#table-of-contents)
 - [About The Project](#about-the-project)
+  - [Built With](#built-with)
 - [Getting Started](#getting-started)
   - [Prerequisites](#prerequisites)
   - [Installation](#installation)

diff --git a/packages/mui/README.md b/packages/mui/README.md
@@ -30,12 +30,14 @@
 <!-- TABLE OF CONTENTS -->
 
 ## Table of Contents
-
+- [Table of Contents](#table-of-contents)
 - [About The Project](#about-the-project)
+  - [Built With](#built-with)
 - [Getting Started](#getting-started)
   - [Prerequisites](#prerequisites)
   - [Installation](#installation)
 - [Usage](#usage)
+  - [Material UI version 5](#material-ui-version-5)
 - [Roadmap](#roadmap)
 - [Contributing](#contributing)
 - [Contact](#contact)

diff --git a/packages/semantic-ui/README.md b/packages/semantic-ui/README.md
@@ -31,11 +31,16 @@
 
 ## Table of Contents
 
+- [Table of Contents](#table-of-contents)
 - [About The Project](#about-the-project)
+  - [Built With](#built-with)
 - [Getting Started](#getting-started)
   - [Prerequisites](#prerequisites)
   - [Installation](#installation)
 - [Usage](#usage)
+- [Optional Semantic UI Theme properties](#optional-semantic-ui-theme-properties)
+    - [Semantic Widget Optional Properties](#semantic-widget-optional-properties)
+    - [Custom Semantic Widget Properties](#custom-semantic-widget-properties)
 - [Roadmap](#roadmap)
 - [Contributing](#contributing)
 - [Contact](#contact)