Merge pull request #147 from kartverket/feature/generic-workflow-for-docs

Feature/generic workflow for docs

Author: EvenSandvik

.github/workflows/update-skip-docs.yaml

@@ -0,0 +1,74 @@
+name: Create a pull request to update documentation on skip.kartverket.no
+
+on:
+  workflow_call:
+    inputs:
+      source_path:
+        type: string
+        required: true
+        description: "Path to the source file to copy"
+      target_path:
+        type: string
+        required: true
+        description: "Path to the target file to copy to"
+      branch_name:
+        type: string
+        required: false
+        default: "update-docs-branch"
+        description: "Branch name for the PR"
+      author_name:
+        type: string
+        required: false
+        default: "GithubActions <workflow@kartverket.no>"
+      identity:
+        type: string
+        required: true
+        description: "The OIDC identity to use for authentication"
+
+jobs:
+  sync-docs:
+    name: Update target repository
+    permissions:
+      contents: write
+      id-token: write
+
+    runs-on: ubuntu-latest
+    steps:
+      - uses: octo-sts/action@6177b4481c00308b3839969c3eca88c96a91775f # v1.0.0 from https://skip.kartverket.no/docs/applikasjon-utrulling/argo-cd/hva-er-et-apps-repo
+        id: octo-sts
+        with:
+          scope: kartverket/skip.kartverket.no
+          identity: ${{ inputs.identity }}
+
+      - name: Checkout source repo
+        uses: actions/checkout@v5
+        with:
+          path: source
+          persist-credentials: false
+
+      - name: Checkout target repo
+        uses: actions/checkout@v5
+        with:
+          path: target
+          repository: kartverket/skip.kartverket.no
+          token: ${{steps.octo-sts.outputs.token}}
+          persist-credentials: false
+
+      - name: Copy source file to target
+        run: |
+          cp source/${SOURCE_PATH} target/${TARGET_PATH}
+        env:
+          SOURCE_PATH: ${{ inputs.source_path }}
+          TARGET_PATH: ${{ inputs.target_path }}
+
+      - name: Create PR
+        uses: peter-evans/create-pull-request@271a8d0340265f705b14b6d32b9829c1cb33d45e
+        with:
+          path: target
+          token: ${{ steps.octo-sts.outputs.token }}
+          branch: ${{ inputs.branch_name }}
+          commit-message: "Update documentation"
+          title: "Update documentation"
+          body: "Automated update of documentation"
+          labels: documentation
+          author: ${{ inputs.author_name }}

README.md

@@ -7,6 +7,7 @@ Shared reusable workflows for GitHub Actions.
   - [run-k8s-manifests-validate](#run-k8s-manifests-validate)
   - [manifest-diff-to-pr-comment](#manifest-diff-to-pr-comment)
   - [auto-merge-dependabot](#auto-merge-dependabot)
+  - [update-skip-docs](#update-skip-docs)
   - [run-terraform](#run-terraform)
 - [Example usage](#example-usage)
   - [Ideal Use of Reusable Workflows](#ideal-use-of-reusable-workflows)
@@ -24,7 +25,7 @@ Shared reusable workflows for GitHub Actions.
 
 # Reusable Workflows
 
-We currently have 4 reusable workflows (i.e. [run-terraform](#run-terraform)) available for use.
+We currently have 6 reusable workflows (i.e. [run-terraform](#run-terraform)) available for use.
 
 See [Ideal Use of Workflows](#ideal-use-of-reusable-workflows) for an example of how to optimally use all 3 workflows together.
 
@@ -257,6 +258,62 @@ The configfile is currently the only input. The configfile at `.github/auto-merg
 | `[].match.update_type`       | string | true     | Which changes should be merged. Currently supports `semver:patch`, `semver:minor` and `semver:major`. The type includes all lower tiers, for example `semver:minor` includes patch changes |
 | `[].match.package_ecosystem` | string | true     | The name of the package ecosystem which the update belongs to, examples; terraform, golang                                                                                                 |
 
+## update-skip-docs
+
+Automatically creates a pull request for updating documentation on skip.kartverket.no when documentation changes are pushed.
+
+### Features
+
+- Syncs changes to documentation files in the source repository to target in skip.kartverket.no
+- Automatically creates or updates documentation in the target repository
+- Creates a branch with the changes in the target repository
+- Requires manual merge of the created branch/PR to allow for review
+
+### Requirements
+
+- The workflow needs write permissions for both `contents` and `id-token`
+- An STS trust file needs to be configured for the target repository
+- The specified identity must have access to the target repository
+
+### Example
+
+Example usage in `.github/workflows/update-docs.yml`:
+```yaml
+name: Update documentation
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - 'README.md'
+
+permissions:
+  contents: write
+  id-token: write
+
+jobs:
+  update-docs:
+    name: Update documentation in target repository
+    uses: kartverket/github-workflows/.github/workflows/update-skip-docs.yaml@latest
+    with:
+      source_path: "README.md"
+      target_path: "docs/03-applikasjon-utrulling/10-argokit/09-argokit-v2.md"
+      branch_name: "update-argokitv2-docs-branch"
+      author_name: "GithubActions <argokit@kartverket.no>"
+      identity: "argokit"
+```
+
+### Inputs
+
+| Key           | Type   | Required | Description                                                                                      |
+|---------------|--------|----------|--------------------------------------------------------------------------------------------------|
+| `source_path`   | string | true        | Path to the documentation file in the source repository                                          |
+| `target_path`   | string | true        | Path where the documentation should be placed in the target repository                           |
+| `branch_name`   | string | false        | Name of the branch to create in the target repository with the documentation updates             |
+| `author_name`   | string | false        | Git author name and email in the format "Name <email@domain.com>" for the commit                 |
+| `identity`      | string | true        | The `identity` to use for authentication with the target repository (must match STS configuration) |
+
 ## run-terraform
 
 This workflow plans and applies Terraform config to deploy to an environment.