ci(editor): Write custom github action for generating changelog from PR names and throw out the changeset package

.github/workflows/editor-changelog.yaml

@@ -0,0 +1,168 @@
+name: Generate Editor Changelog
+
+on:
+  push:
+    branches:
+      - '**' # Runs on all branches
+
+jobs:
+  generate-changelog:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+
+      - name: Install dependencies
+        run: yarn
+
+      - name: Get current version of editor package
+        id: get_local_version
+        run: |
+          CURRENT_VERSION=$(node -p "require('./packages/editor/package.json').version")
+          echo "CURRENT_VERSION=$CURRENT_VERSION" >> $GITHUB_ENV
+
+      - name: Check if changelog for this version already exists
+        id: check_existing_changelog
+        run: |
+          if [ -f packages/editor/CHANGELOG.md ] && grep -q "## Changelog for version $CURRENT_VERSION" packages/editor/CHANGELOG.md; then
+            echo "changelog_exists=true" >> $GITHUB_ENV
+          else
+            echo "changelog_exists=false" >> $GITHUB_ENV
+          fi
+
+      - name: Get latest published version from npm
+        if: env.changelog_exists == 'false'
+        id: get_npm_version
+        run: |
+          NPM_VERSION=$(npm view @serlo/editor version)
+          echo "NPM_VERSION=$NPM_VERSION" >> $GITHUB_ENV
+
+      - name: Check if version has changed
+        if: env.changelog_exists == 'false'
+        id: check_version
+        run: |
+          if [ "$CURRENT_VERSION" != "$NPM_VERSION" ]; then
+            echo "version_changed=true" >> $GITHUB_ENV
+          else
+            echo "version_changed=false" >> $GITHUB_ENV
+          fi
+
+      - name: Stop if version has not changed
+        if: env.version_changed == 'false'
+        run: exit 0
+
+      - name: Get last tag for editor package (if available)
+        if: env.version_changed == 'true'
+        id: get_last_tag
+        run: |
+          git fetch --all --tags
+          LAST_TAG=$(git describe --tags --match "v*-editor" --abbrev=0 2>/dev/null || echo "none")
+          if [ "$LAST_TAG" == "none" ]; then
+            echo "No previous tag found, this is the first release"
+            echo "LAST_TAG=" >> $GITHUB_ENV
+          else
+            echo "LAST_TAG=$LAST_TAG" >> $GITHUB_ENV
+          fi
+
+      - name: Check if there are changes in packages/editor since last tag
+        if: env.version_changed == 'true'
+        id: check_editor_changes
+        run: |
+          if [ -z "$LAST_TAG" ]; then
+            # No previous tag, assume all changes in editor are new
+            echo "no_editor_changes=false" >> $GITHUB_ENV
+          else
+            # Compare changes since the last tag
+            CHANGED_FILES=$(git diff --name-only $LAST_TAG HEAD -- packages/editor)
+            if [ -z "$CHANGED_FILES" ]; then
+              echo "no_editor_changes=true" >> $GITHUB_ENV
+            else
+              echo "no_editor_changes=false" >> $GITHUB_ENV
+            fi
+          fi
+
+      - name: Stop if no changes in packages/editor
+        if: env.no_editor_changes == 'true'
+        run: exit 0
+
+      - name: Get merged PRs affecting editor package (last 10 if no tag)
+        if: env.version_changed == 'true' && env.no_editor_changes == 'false'
+        id: get_prs
+        run: |
+          if [ -z "$LAST_TAG" ]; then
+            # No tag, get last 10 PRs
+            PRS=$(curl -s "https://api.github.com/repos/serlo/frontend/pulls?state=closed&per_page=10" | jq -r '.[] | .number' | tr '\n' ' ')
+          else
+            # Fetch PRs since last tag
+            PRS=$(curl -s "https://api.github.com/repos/serlo/frontend/pulls?state=closed&per_page=100" | jq -r '.[] | select(.merged_at != null and .merged_at > $GITHUB_ENV.LAST_TAG and .head.repo.full_name == "serlo/frontend") | .number' | tr '\n' ' ')
+          fi
+          echo "PR_NUMBERS=$PRS" >> $GITHUB_ENV
+
+      - name: Get PR titles that touched editor folder
+        if: env.version_changed == 'true' && env.no_editor_changes == 'false'
+        id: get_pr_titles
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          PR_TITLES=""
+          IFS=' ' read -r -a PR_ARRAY <<< "$PR_NUMBERS"
+          echo "Processing ${#PR_ARRAY[@]} PRs"
+          for pr in "${PR_ARRAY[@]}"; do
+            echo "Checking PR #$pr"
+            PR_DATA=$(curl -s -H "Authorization: token $GH_TOKEN" "https://api.github.com/repos/${{ github.repository }}/pulls/$pr")
+            if [ $? -ne 0 ]; then
+              echo "Error fetching PR data for #$pr"
+              continue
+            fi
+
+            MERGED=$(echo "$PR_DATA" | jq -r '.merged')
+            if [ "$MERGED" != "true" ]; then
+              echo "PR #$pr was not merged, skipping"
+              continue
+            fi
+
+            FILES=$(curl -s -H "Authorization: token $GH_TOKEN" "https://api.github.com/repos/${{ github.repository }}/pulls/$pr/files")
+            if [ $? -ne 0 ]; then
+              echo "Error fetching files for PR #$pr"
+              continue
+            fi
+
+            if echo "$FILES" | jq -r '.[].filename' | grep -q "^packages/editor/"; then
+              PR_TITLE=$(echo "$PR_DATA" | jq -r '.title')
+              echo "PR #$pr touches editor package. Title: $PR_TITLE"
+              PR_TITLES="${PR_TITLES}- ${PR_TITLE}\n"
+            else
+              echo "PR #$pr does not touch editor package"
+            fi
+          done
+          echo "Final PR_TITLES: $PR_TITLES"
+          if [ -n "$PR_TITLES" ]; then
+            # Escape special characters and set PR_TITLES as an environment variable
+            escaped_titles=$(printf '%s\n' "$PR_TITLES" | sed -e 's/"/\\"/g' -e 's/!/\\!/g')
+            echo "PR_TITLES<<EOF" >> $GITHUB_ENV
+            echo "$escaped_titles" >> $GITHUB_ENV
+            echo "EOF" >> $GITHUB_ENV
+          else
+            echo "PR_TITLES=No relevant PRs found" >> $GITHUB_ENV
+          fi
+        shell: bash
+
+      - name: Generate Changelog
+        if: env.version_changed == 'true' && env.no_editor_changes == 'false' && env.PR_TITLES != 'No relevant PRs found'
+        run: |
+          echo "## Changelog for version $CURRENT_VERSION" > packages/editor/CHANGELOG.md
+          echo "" >> packages/editor/CHANGELOG.md  # Adds a newline after the heading
+          echo -e "$PR_TITLES" >> packages/editor/CHANGELOG.md
+
+      - name: Commit and Push Changelog
+        if: env.version_changed == 'true' && env.no_editor_changes == 'false' && env.PR_TITLES != 'No relevant PRs found'
+        run: |
+          git config --local user.email "41898282+github-actions[bot]@users.noreply.github.com"
+          git config --local user.name "GitHub Action Bot"
+          git add packages/editor/CHANGELOG.md
+          git commit -m "chore: update changelog for version $CURRENT_VERSION"
+          git push origin ${{ github.ref_name }}

.github/workflows/editor.yaml

@@ -4,105 +4,66 @@ on:
   push:
     branches:
       - staging
-      - editor-package-vite
 
 jobs:
   build-and-publish:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
+
       - uses: actions/setup-node@v4
         with:
           node-version: 20
           registry-url: https://registry.npmjs.org
+
       - run: yarn
 
       - name: Build editor package
         run: yarn editor:build
 
-      - name: Apply Changesets and Version Bump
-        run: yarn changeset version
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      - name: Get current version from package.json
+        id: get_version
+        run: echo "CURRENT_VERSION=$(node -p "require('./packages/editor/package.json').version")" >> $GITHUB_ENV
 
-      - name: Check if the next version is already published
+      - name: Check if current version is already published
         id: check_published
         run: |
-          NEXT_VERSION=$(node -p "require('./packages/editor/package.json').version")
-          if npm view @serlo/editor@$NEXT_VERSION > /dev/null 2>&1; then
+          CURRENT_VERSION=$(node -p "require('./packages/editor/package.json').version")
+          if npm view @serlo/editor@$CURRENT_VERSION > /dev/null 2>&1; then
             echo "already_published=true" >> $GITHUB_OUTPUT
           else
             echo "already_published=false" >> $GITHUB_OUTPUT
-          fi
 
-      - name: Create a new branch for the version bump
+      - name: Publish to npm
         if: steps.check_published.outputs.already_published == 'false'
-        run: |
-          NEXT_VERSION=$(node -p "require('./packages/editor/package.json').version")
-          git config --global user.name 'GitHub Actions'
-          git config --global user.email '[email protected]'
-          git checkout -b "release/@serlo/editor-$NEXT_VERSION"
-
-      - name: Check if changes occurred after version bump
-        id: check_changes
-        run: |
-          git add .
-          if git diff --exit-code --quiet; then
-            echo "no_changes=true" >> $GITHUB_OUTPUT
-          else
-            echo "no_changes=false" >> $GITHUB_OUTPUT
-          fi
-
-      - name: Commit changes to the new branch
-        if: steps.check_published.outputs.already_published == 'false' && steps.check_changes.outputs.no_changes == 'false'
-        run: |
-          NEXT_VERSION=$(node -p "require('./packages/editor/package.json').version")
-          git add .
-          git commit -m "chore(release): bump @serlo/editor to version $NEXT_VERSION"
-          git push origin "release/@serlo/editor-$NEXT_VERSION"
+        run: yarn editor:publish
         env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
 
-      - name: Create Pull Request
-        if: steps.check_published.outputs.already_published == 'false' && steps.check_changes.outputs.no_changes == 'false'
-        id: create_pr
+      - name: Create and push Git tag
+        if: steps.check_published.outputs.already_published == 'false'
         run: |
-          NEXT_VERSION=$(node -p "require('./packages/editor/package.json').version")
-          PR_URL=$(gh pr create --title "Release: Bump @serlo/editor to version $NEXT_VERSION" --body "Automated PR to bump @serlo/editor to $NEXT_VERSION" --base staging --head "release/@serlo/editor-$NEXT_VERSION" --json url -q .url)
-          echo "pr_url=$PR_URL" >> $GITHUB_OUTPUT
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          VERSION=$(node -p "require('./packages/editor/package.json').version")
+          git tag v$VERSION
+          git push origin v$VERSION
 
-      - name: Wait for PR to be merged
-        if: steps.create_pr.outputs.pr_url
+      - name: Extract changelog for current version
+        id: extract_changelog
         run: |
-          PR_URL="${{ steps.create_pr.outputs.pr_url }}"
-          while true; do
-            PR_STATE=$(gh pr view $PR_URL --json state -q .state)
-            if [ "$PR_STATE" = "MERGED" ]; then
-              echo "PR has been merged"
-              break
-            elif [ "$PR_STATE" = "CLOSED" ]; then
-              echo "PR was closed without merging"
-              exit 1
-            fi
-            echo "Waiting for PR to be merged..."
-            sleep 60
-          done
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-
-      - name: Publish to npm (after PR merge)
-        if: steps.check_published.outputs.already_published == 'false' && steps.create_pr.outputs.pr_url
-        run: yarn editor:publish
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+          CURRENT_VERSION=$(node -p "require('./packages/editor/package.json').version")
+          CHANGELOG=$(awk "/## Changelog for version $CURRENT_VERSION/,/^##/" packages/editor/CHANGELOG.md | sed '$d')
+          echo "RELEASE_NOTES<<EOF" >> $GITHUB_ENV
+          echo "$CHANGELOG" >> $GITHUB_ENV
+          echo "EOF" >> $GITHUB_ENV
 
-      - name: Create GitHub Release (after PR merge)
-        if: steps.check_published.outputs.already_published == 'false' && steps.create_pr.outputs.pr_url
-        run: |
-          NEXT_VERSION=$(node -p "require('./packages/editor/package.json').version")
-          body=$(git log -1 --pretty=format:%B)
-          gh release create "v$NEXT_VERSION" --notes "$body"
+      - name: Create GitHub Release
+        if: steps.check_published.outputs.already_published == 'false'
+        uses: elgohr/Github-Release-Action@v5
         env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          tag: v${{ steps.get_version.outputs.CURRENT_VERSION }}
+          title: 'Serlo Editor - v${{ steps.get_version.outputs.CURRENT_VERSION }}'
+          body: |
+            ## Serlo Editor Release Notes
+            ${{ env.RELEASE_NOTES }}

package.json

@@ -47,7 +47,6 @@
     "test": "yarn workspace @serlo/frontend test"
   },
   "devDependencies": {
-    "@changesets/cli": "^2.27.9",
     "@serlo/eslint-config": "workspace:*",
     "@serlo/typescript-config": "workspace:*",
     "cross-env": "^7.0.3",

packages/editor/.prettierignore

@@ -1,3 +1,4 @@
 # this also checks .gitignore
 
-dist
+dist
+CHANGELOG.md

packages/editor/CHANGELOG.md

@@ -0,0 +1,7 @@
+## Changelog for version 0.15.4
+
+- ci(fix): Only publish new version after PR gets merged
+- Ci/GitHub action creates pr with changeset
+- refactor: move experiments to editor
+- fix(plugin-rows): hydration error in anchor link copy tool
+- fix(exercise): update titles

packages/editor/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@serlo/editor",
-  "version": "0.15.3",
+  "version": "0.15.4",
   "homepage": "https://de.serlo.org/editor",
   "bugs": {
     "url": "https://github.com/serlo/frontend/issues"