fix: add note in TODO about docs

sanity-io · Aug 17, 2022 · 0b6ecdc · 0b6ecdc
1 parent 3e95caa
commit 0b6ecdc
Show file tree

Hide file tree

Showing 2 changed files with 32 additions and 33 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -28,21 +28,17 @@ concurrency:
   cancel-in-progress: true
 
 jobs:
-  log-the-inputs:
-    runs-on: ubuntu-latest
-    steps:
-      - run: |
-          echo "concurrency.group: $GROUP"
-          echo "Publish new release: $RELEASE"
-          echo "Run tests: $TEST"
-        env:
-          GROUP: ${{ github.workflow }}-${{ github.head_ref || github.ref }}-${{ github.event.inputs.release || 'no-release' }}
-          RELEASE: ${{ inputs.release }}
-          TEST: ${{ inputs.test }}
-      - run: echo test is boolean false
-        if: ${{ github.event.inputs.test == false }}
-      - run: echo test is string 'false'
-        if: ${{ github.event.inputs.test != 'false' }}
+  # log-the-inputs:
+  #   runs-on: ubuntu-latest
+  #   steps:
+  #     - run: |
+  #         echo "concurrency.group: $GROUP"
+  #         echo "Publish new release: $RELEASE"
+  #         echo "Run tests: $TEST"
+  #       env:
+  #         GROUP: ${{ github.workflow }}-${{ github.head_ref || github.ref }}-${{ github.event.inputs.release || 'no-release' }}
+  #         RELEASE: ${{ inputs.release }}
+  #         TEST: ${{ inputs.test }}
 
   build:
     runs-on: ubuntu-latest
@@ -74,25 +70,25 @@ jobs:
       - run: npm ci
       - run: npm test --if-present
 
-  test-needs-success:
-    needs: test
-    if: always() && github.event.inputs.release == 'true' && needs.test.result == 'success'
-    runs-on: ubuntu-latest
-    steps:
-      - env:
-          NEEDS: ${{ toJSON(needs) }}     
-        run: |
-          echo "$NEEDS"
+  # test-needs-success:
+  #   needs: test
+  #   if: always() && github.event.inputs.release == 'true' && needs.test.result == 'success'
+  #   runs-on: ubuntu-latest
+  #   steps:
+  #     - env:
+  #         NEEDS: ${{ toJSON(needs) }}     
+  #       run: |
+  #         echo "$NEEDS"
 
-  test-needs-skipped:
-    needs: test
-    if: always() && github.event.inputs.release == 'true' && needs.test.result == 'skipped'
-    runs-on: ubuntu-latest
-    steps:
-      - env:
-          NEEDS: ${{ toJSON(needs) }}     
-        run: |
-          echo "$NEEDS"
+  # test-needs-skipped:
+  #   needs: test
+  #   if: always() && github.event.inputs.release == 'true' && needs.test.result == 'skipped'
+  #   runs-on: ubuntu-latest
+  #   steps:
+  #     - env:
+  #         NEEDS: ${{ toJSON(needs) }}     
+  #       run: |
+  #         echo "$NEEDS"
 
   release:
     needs: test

diff --git a/README.md b/README.md
@@ -25,6 +25,7 @@
   - [Minimal GitHub Release workflow](#minimal-github-release-workflow)
     - [If you're unable to make it work chances are your issue is documented in the `semantic-release` troubleshooting docs.](#if-youre-unable-to-make-it-work-chances-are-your-issue-is-documented-in-the-semantic-release-troubleshooting-docs)
   - [Opinionated GitHub Release workflow](#opinionated-github-release-workflow)
+    - [TODO more docs are coming, we're actively exploring the optimal setup](#todo-more-docs-are-coming-were-actively-exploring-the-optimal-setup)
 - [Next steps, for even more automation](#next-steps-for-even-more-automation)
 
 # Usage
@@ -236,6 +237,8 @@ Check the [Release Workflow docs](https://semantic-release.gitbook.io/semantic-r
 2. Runs `test`, which runs a matrix of operating systems and node versions.
 3. FInally, runs `release`, if the workflow started from a `workflow_dispatch`, it is skipped on `push`.
 
+### TODO more docs are coming, we're actively exploring the optimal setup
+
 # Next steps, for even more automation
 
 - Setup [Renovatebot](https://docs.renovatebot.com/) dependencies automation [with our preset](https://github.com/sanity-io/renovate-presets/blob/master/ecosystem/README.md).