Merge pull request #35 from code0-tech/25-pipeline-for-snapshot-regenerate

Add pipeline to regenerate image snapshots

Author: Taucher2003

.github/workflows/update_snapshots.yml

@@ -0,0 +1,35 @@
+name: CI / Update Snapshots
+
+on:
+  pull_request_target:
+    types:
+      - labeled
+
+permissions:
+  pull-requests: write
+  contents: write
+
+jobs:
+  pipeline:
+    if: ${{ github.event.label.name == 'regenerate-snapshots' }}
+    runs-on: ubuntu-latest
+    steps:
+      - uses: Taucher2003/GitLab-Pipeline-Action@1.5.0
+        name: Run pipeline
+        id: pipeline
+        with:
+          GL_SERVER_URL: https://gitlab.com
+          GL_PROJECT_ID: '52344025'
+          GL_RUNNER_TOKEN: ${{ secrets.GL_RUNNER_TOKEN }}
+          GL_API_TOKEN: ${{ secrets.GL_API_TOKEN }}
+          SHOW_JOB_LOGS: all
+        env:
+          GLPA_C0_UPDATE_SNAPSHOTS: 'true'
+          GLPA_C0_GH_PR_HEAD_URL: ${{ github.event.pull_request.head.repo.clone_url }}
+          GLPA_C0_GH_PR_HEAD_REF: ${{ github.event.pull_request.head.ref }}
+          GLPA_C0_GH_BOT_PUSH_ACCESS_TOKEN: ${{ secrets.GH_BOT_PUSH_ACCESS_TOKEN }}
+          GLPA_C0_GH_BOT_PUSH_USERNAME: ${{ secrets.GH_BOT_PUSH_USERNAME }}
+      - run: gh pr edit "${{ github.event.number }}" --remove-label "regenerate-snapshots"
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          GH_REPO: ${{ github.repository }}

.gitlab-ci.yml

@@ -3,6 +3,10 @@ include:
     ref: build-branch
     file: ci-template.gitlab-ci.yml
 
+docs:
+  rules:
+    - if: $C0_UPDATE_SNAPSHOTS == null
+
 storybook:build:
   image: node:20.9.0
   stage: build
@@ -21,22 +25,29 @@ storybook:build:
     paths:
       - storybook-static
     expire_in: 7 days
+  rules:
+    - if: $C0_UPDATE_SNAPSHOTS == null
 
-storybook:test:
+.storybook:test:base:
   image: ghcr.io/code0-tech/build-images/node-20.9-playwright:6.1
   stage: test
-  script:
+  before_script:
     - source ~/.asdf/asdf.sh
     - npm ci
     - npm run storybook:dev &
     - curl --fail -sv --retry 30 --retry-delay 3 --head --retry-all-errors http://127.0.0.1:6006
+
+storybook:test:
+  extends:
+    - .storybook:test:base
+  script:
     - npm run storybook:test:all -- --ci || exit_code=$?
     - |
       if [[ $exit_code -ne 0 && -d "__snapshots__/__diff_output__" ]]; then
         echo -e "\e[0Ksection_start:`date +%s`:glpa_summary\r\e[0KHeader of the summary"
         echo "Storybook tests failed."
         echo "Check for rendering differences at http://gitlab.com/code0-tech/pictor/-/jobs/$CI_JOB_ID/artifacts/browse/__snapshots__/__diff_output__/"
-        echo "If the changes are intended, update the fixtures with npm run storybook:test:update"
+        echo "If the changes are intended, update the snapshots by adding the 'regenerate-snapshots' label."
         echo -e "\e[0Ksection_end:`date +%s`:glpa_summary\r\e[0K"
       fi
       exit $exit_code
@@ -45,3 +56,26 @@ storybook:test:
     paths:
       - __snapshots__/__diff_output__
     expire_in: 7 days
+  rules:
+    - if: $C0_UPDATE_SNAPSHOTS == null
+
+storybook:test:update:
+  extends:
+    - .storybook:test:base
+  before_script:
+    - git remote add github $C0_GH_PR_HEAD_URL
+    - git fetch github
+    - git checkout $C0_GH_PR_HEAD_REF
+    - !reference [.storybook:test:base, before_script]
+  script:
+    - npm run storybook:test:update
+    - git add __snapshots__
+    - git config --global user.name "github-actions[bot]"
+    - git config --global user.email "41898282+github-actions[bot]@users.noreply.github.com"
+    - git commit -m "Update image snapshots"
+    - >
+      git
+      -c credential.helper='!f() { sleep 1; echo "username=${C0_GH_BOT_PUSH_USERNAME}"; echo "password=${C0_GH_BOT_PUSH_ACCESS_TOKEN}"; }; f'
+      push github $C0_GH_PR_HEAD_REF
+  rules:
+    - if: $C0_UPDATE_SNAPSHOTS