[DPE-2319] Enabling Discourse Gatekeeper one-way sync (#63)

Author: deusebio

.github/workflows/ci.yaml

@@ -53,6 +53,13 @@ jobs:
       - name: Run tests
         run: tox run -e security
 
+  sync-docs:
+    uses: ./.github/workflows/sync_docs.yaml
+    secrets: inherit
+    permissions:
+      contents: write  # Needed to update tags
+      pull-requests: write # Need to create PR
+
   build:
     name: Build charms
     uses: canonical/data-platform-workflows/.github/workflows/build_charms_with_cache.yaml@v2

.github/workflows/release.yaml

@@ -27,6 +27,11 @@ jobs:
     needs:
       - lib-check
     uses: ./.github/workflows/ci.yaml
+    secrets: inherit
+    permissions:
+      contents: write  # Needed to login to Discourse
+      pull-requests: write # Need to create PR
+      actions: write
 
   build:
     name: Build charm

.github/workflows/sync_docs.yaml

@@ -0,0 +1,29 @@
+name: Sync docs from Discourse
+
+on:
+  workflow_dispatch:
+  schedule:
+    - cron: '53 0 * * *' # Daily at 00:53 UTC
+  # Triggered on push to branch "main" by .github/workflows/release.yaml
+  workflow_call:
+
+jobs:
+  sync-docs:
+    name: Open PR with docs changes
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Open PR with docs changes
+        uses: deusebio/discourse-gatekeeper@main
+        id: docs-pr
+        with:
+          discourse_host: discourse.charmhub.io
+          discourse_api_username: ${{ secrets.DISCOURSE_API_USERNAME }}
+          discourse_api_key: ${{ secrets.DISCOURSE_API_KEY }}
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          dry_run: "true"
+
+      - name: Show migrate output
+        run: echo '${{ steps.docs-pr.outputs.migrate }}'
+      - name: Show reconcile output
+        run: echo '${{ steps.docs-pr.outputs.reconcile }}'