Merge pull request #28 from gradle/previews

Enable website previews for the Cookbook

.github/workflows/ci.yml

@@ -12,6 +12,17 @@ jobs:
   # Build job
   build:
     runs-on: ubuntu-latest
+
+    permissions:
+      contents: write
+      packages: read
+      pull-requests: write
+
+    env:
+      PR_PATH: pull/${{github.event.number}}
+      DOMAIN: gradle.github.io
+      PREVIEW_REPO: community-site-preview
+
     steps:
       - name: Checkout
         uses: actions/checkout@v3
@@ -28,3 +39,27 @@ jobs:
 
       - name: Build the docs
         run: mkdocs build
+
+      - name: Deploy to PR preview
+        uses: peaceiris/actions-gh-pages@v4
+        if: github.ref != 'refs/heads/main'
+        with:
+          deploy_key: ${{ secrets.PREVIEW_DEPLOYMENT_KEY }}
+          external_repository: gradle/${{ env.PREVIEW_REPO }}
+          publish_dir: ./_site
+          destination_dir: ${{ env.PR_PATH }}
+
+      - name: Update comment
+        uses: hasura/[email protected]
+        if: github.ref != 'refs/heads/main'
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          repository: ${{ github.repository }}
+          number: ${{ github.event.number }}
+          id: deploy-preview
+          message: > 
+            A preview of ${{ github.event.after }} is uploaded and can be seen here:
+            
+            ✨ https://${{ env.DOMAIN }}/${{ env.PREVIEW_REPO }}/${{ env.PR_PATH}}/ ✨
+            
+            Changes may take a few minutes to propagate. 

.github/workflows/preview-cleanup.yml

@@ -0,0 +1,37 @@
+name: Delete preview on PR close
+on:
+  pull_request:
+    types: [closed]
+
+jobs:
+  delete_preview:
+    runs-on: ubuntu-20.04
+    env:
+      PR_PATH: pull/${{github.event.number}}
+      DOMAIN: gradle.github.io
+      PREVIEW_REPO: community-site-preview
+
+    permissions:
+      pull-requests: write
+
+    steps:
+      - name: make empty dir
+        run: mkdir public
+
+      - name: delete folder
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          deploy_key: ${{ secrets.PREVIEW_DEPLOYMENT_KEY }}
+          external_repository: gradle/${{ env.PREVIEW_REPO }}
+          publish_dir: ./public
+          destination_dir: ${{ env.PR_PATH }}
+
+      - name: Comment on PR
+        uses: hasura/[email protected]
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          repository: ${{ github.repository }}
+          number: ${{ github.event.number }}
+          id: deploy-preview
+          message: > 
+            🪓 PR closed, deleted preview at https://github.com/${{ env.PREVIEW_REPO }}/tree/gh-pages/${{ env.PR_PATH }}/

docs/CONTRIBUTING.md

@@ -31,6 +31,12 @@ When adding new pages, please update the ToC to ensure they are discoverable.
 At the moment, we add categories based on consensus.
 If you plan to add a new major category, it's better to discuss it in advance.
 
+## Previews
+
+For any pull equest with the approved GitHub Actions run,
+a preview site will be deployed.
+The build both will share the link in the comments to the pull request.
+
 ## References
 
 - [Main Contributor Guide](https://community.gradle.org/contributing/) - describes how to contribute to Gradle