Add script to create historical changelog

.github/workflows/build.yml

@@ -15,9 +15,9 @@ on:
 
 env:
   JOB_TRANSFER_ARTIFACT: build-artifacts
+  CHANGELOG_ARTIFACTS: changelog
 
 jobs:
-
   build:
     if: github.repository == 'arduino/arduino-ide'
     strategy:
@@ -56,29 +56,29 @@ jobs:
           IS_RELEASE: ${{ startsWith(github.ref, 'refs/tags/') }}
           IS_FORK: ${{ github.event.pull_request.head.repo.fork == true }}
         run: |
-            # See: https://www.electron.build/code-signing
-            if [ $IS_FORK = true ]; then
-              echo "Skipping the app signing: building from a fork."
-            else
-              if [ "${{ runner.OS }}" = "macOS" ]; then
-                export CSC_LINK="${{ runner.temp }}/signing_certificate.p12"
-                # APPLE_SIGNING_CERTIFICATE_P12 secret was produced by following the procedure from:
-                # https://www.kencochrane.com/2020/08/01/build-and-sign-golang-binaries-for-macos-with-github-actions/#exporting-the-developer-certificate
-                echo "${{ secrets.APPLE_SIGNING_CERTIFICATE_P12 }}" | base64 --decode > "$CSC_LINK"
-
-                export CSC_KEY_PASSWORD="${{ secrets.KEYCHAIN_PASSWORD }}"
-
-              elif [ "${{ runner.OS }}" = "Windows" ]; then
-                export CSC_LINK="${{ runner.temp }}/signing_certificate.pfx"
-                npm config set msvs_version 2017 --global
-                echo "${{ secrets.WINDOWS_SIGNING_CERTIFICATE_PFX }}" | base64 --decode > "$CSC_LINK"
-
-                export CSC_KEY_PASSWORD="${{ secrets.WINDOWS_SIGNING_CERTIFICATE_PASSWORD }}"
-              fi
+          # See: https://www.electron.build/code-signing
+          if [ $IS_FORK = true ]; then
+            echo "Skipping the app signing: building from a fork."
+          else
+            if [ "${{ runner.OS }}" = "macOS" ]; then
+              export CSC_LINK="${{ runner.temp }}/signing_certificate.p12"
+              # APPLE_SIGNING_CERTIFICATE_P12 secret was produced by following the procedure from:
+              # https://www.kencochrane.com/2020/08/01/build-and-sign-golang-binaries-for-macos-with-github-actions/#exporting-the-developer-certificate
+              echo "${{ secrets.APPLE_SIGNING_CERTIFICATE_P12 }}" | base64 --decode > "$CSC_LINK"
+
+              export CSC_KEY_PASSWORD="${{ secrets.KEYCHAIN_PASSWORD }}"
+
+            elif [ "${{ runner.OS }}" = "Windows" ]; then
+              export CSC_LINK="${{ runner.temp }}/signing_certificate.pfx"
+              npm config set msvs_version 2017 --global
+              echo "${{ secrets.WINDOWS_SIGNING_CERTIFICATE_PFX }}" | base64 --decode > "$CSC_LINK"
+
+              export CSC_KEY_PASSWORD="${{ secrets.WINDOWS_SIGNING_CERTIFICATE_PASSWORD }}"
             fi
+          fi
 
-            yarn --cwd ./electron/packager/
-            yarn --cwd ./electron/packager/ package
+          yarn --cwd ./electron/packager/
+          yarn --cwd ./electron/packager/ package
 
       - name: Upload [GitHub Actions]
         uses: actions/upload-artifact@v2
@@ -95,15 +95,15 @@ jobs:
     strategy:
       matrix:
         artifact:
-          - path: "*Linux_64bit.zip"
+          - path: '*Linux_64bit.zip'
             name: Linux_X86-64
-          - path: "*macOS_64bit.dmg"
+          - path: '*macOS_64bit.dmg'
             name: macOS
-          - path: "*Windows_64bit.exe"
+          - path: '*Windows_64bit.exe'
             name: Windows_X86-64_interactive_installer
-          - path: "*Windows_64bit.msi"
+          - path: '*Windows_64bit.msi'
             name: Windows_X86-64_MSI
-          - path: "*Windows_64bit.zip"
+          - path: '*Windows_64bit.zip'
             name: Windows_X86-64_zip
 
     steps:
@@ -112,7 +112,7 @@ jobs:
         with:
           name: ${{ env.JOB_TRANSFER_ARTIFACT }}
           path: ${{ env.JOB_TRANSFER_ARTIFACT }}
-      
+
       - name: Upload tester build artifact
         uses: actions/upload-artifact@v2
         with:
@@ -135,24 +135,24 @@ jobs:
         env:
           IS_RELEASE: ${{ startsWith(github.ref, 'refs/tags/') }}
         run: |
-            export LATEST_TAG=$(git describe --abbrev=0)
-            export GIT_LOG=$(git log --pretty=" - %s [%h]" $LATEST_TAG..HEAD | sed 's/ *$//g')
-            if [ "$IS_RELEASE" = true ]; then
-              export BODY=$(echo -e "$GIT_LOG")
-            else 
-              export LATEST_TAG_WITH_LINK=$(echo "[$LATEST_TAG](https://github.com/arduino/arduino-ide/releases/tag/$LATEST_TAG)")
-              if [ -z "$GIT_LOG" ]; then
-                  export BODY="There were no changes since version $LATEST_TAG_WITH_LINK."
-              else
-                  export BODY=$(echo -e "Changes since version $LATEST_TAG_WITH_LINK:\n$GIT_LOG")
-              fi
+          export LATEST_TAG=$(git describe --abbrev=0)
+          export GIT_LOG=$(git log --pretty=" - %s [%h]" $LATEST_TAG..HEAD | sed 's/ *$//g')
+          if [ "$IS_RELEASE" = true ]; then
+            export BODY=$(echo -e "$GIT_LOG")
+          else
+            export LATEST_TAG_WITH_LINK=$(echo "[$LATEST_TAG](https://github.com/arduino/arduino-ide/releases/tag/$LATEST_TAG)")
+            if [ -z "$GIT_LOG" ]; then
+                export BODY="There were no changes since version $LATEST_TAG_WITH_LINK."
+            else
+                export BODY=$(echo -e "Changes since version $LATEST_TAG_WITH_LINK:\n$GIT_LOG")
             fi
-            echo -e "$BODY"
-            OUTPUT_SAFE_BODY="${BODY//'%'/'%25'}"
-            OUTPUT_SAFE_BODY="${OUTPUT_SAFE_BODY//$'\n'/'%0A'}"
-            OUTPUT_SAFE_BODY="${OUTPUT_SAFE_BODY//$'\r'/'%0D'}"
-            echo "::set-output name=BODY::$OUTPUT_SAFE_BODY"
-            echo "$BODY" > CHANGELOG.txt
+          fi
+          echo -e "$BODY"
+          OUTPUT_SAFE_BODY="${BODY//'%'/'%25'}"
+          OUTPUT_SAFE_BODY="${OUTPUT_SAFE_BODY//$'\n'/'%0A'}"
+          OUTPUT_SAFE_BODY="${OUTPUT_SAFE_BODY//$'\r'/'%0D'}"
+          echo "::set-output name=BODY::$OUTPUT_SAFE_BODY"
+          echo "$BODY" > CHANGELOG.txt
 
       - name: Upload Changelog [GitHub Actions]
         if: github.event_name == 'schedule' || (github.event_name == 'workflow_dispatch' && github.ref == 'refs/heads/main')
@@ -175,9 +175,9 @@ jobs:
       - name: Publish Nightly [S3]
         uses: docker://plugins/s3
         env:
-          PLUGIN_SOURCE: "${{ env.JOB_TRANSFER_ARTIFACT }}/*"
-          PLUGIN_STRIP_PREFIX: "${{ env.JOB_TRANSFER_ARTIFACT }}/"
-          PLUGIN_TARGET: "/arduino-ide/nightly"
+          PLUGIN_SOURCE: '${{ env.JOB_TRANSFER_ARTIFACT }}/*'
+          PLUGIN_STRIP_PREFIX: '${{ env.JOB_TRANSFER_ARTIFACT }}/'
+          PLUGIN_TARGET: '/arduino-ide/nightly'
           PLUGIN_BUCKET: ${{ secrets.DOWNLOADS_BUCKET }}
           AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
           AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
@@ -211,9 +211,9 @@ jobs:
       - name: Publish Release [S3]
         uses: docker://plugins/s3
         env:
-          PLUGIN_SOURCE: "${{ env.JOB_TRANSFER_ARTIFACT }}/*"
-          PLUGIN_STRIP_PREFIX: "${{ env.JOB_TRANSFER_ARTIFACT }}/"
-          PLUGIN_TARGET: "/arduino-ide"
+          PLUGIN_SOURCE: '${{ env.JOB_TRANSFER_ARTIFACT }}/*'
+          PLUGIN_STRIP_PREFIX: '${{ env.JOB_TRANSFER_ARTIFACT }}/'
+          PLUGIN_TARGET: '/arduino-ide'
           PLUGIN_BUCKET: ${{ secrets.DOWNLOADS_BUCKET }}
           AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
           AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}

.github/workflows/compose-full-changelog.yaml

@@ -0,0 +1,45 @@
+name: Compose full changelog
+
+on:
+  release:
+    types: [created, edited]
+
+env:
+  CHANGELOG_ARTIFACTS: changelog
+
+jobs:
+  create-changelog:
+    if: github.repository == 'arduino/arduino-ide'
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Get Tag
+        id: tag_name
+        run: |
+          echo ::set-output name=TAG_NAME::${GITHUB_REF#refs/tags/}
+
+      - name: Create full changelog
+        id: full-changelog
+        run: |
+          mkdir "${{ github.workspace }}/${{ env.CHANGELOG_ARTIFACTS }}"
+
+          # Get the changelog file name to build
+          CHANGELOG_FILE_NAME="${{ steps.tag_name.outputs.TAG_NAME }}-${date --iso-8601=s}.md"
+
+          # Create manifest file pointing to latest changelog file name
+          echo "$CHANGELOG_FILE_NAME" >> "${{ github.workspace }}/${{ env.CHANGELOG_ARTIFACTS }}/latest.txt"
+
+          # Compose changelog
+          yarn run compose-changelog "${{ github.workspace }}/${{ env.CHANGELOG_ARTIFACTS }}/$CHANGELOG_FILE_NAME"
+
+      - name: Publish Changelog [S3]
+        uses: docker://plugins/s3
+        env:
+          PLUGIN_SOURCE: '${{ env.CHANGELOG_ARTIFACTS }}/*'
+          PLUGIN_STRIP_PREFIX: '${{ env.CHANGELOG_ARTIFACTS }}/'
+          PLUGIN_TARGET: '/arduino-ide/changelog'
+          PLUGIN_BUCKET: ${{ secrets.DOWNLOADS_BUCKET }}
+          AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
+          AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}

arduino-ide-extension/package.json

@@ -6,6 +6,7 @@
   "scripts": {
     "prepare": "yarn download-cli && yarn download-fwuploader && yarn download-ls && yarn copy-serial-plotter && yarn clean && yarn download-examples && yarn build && yarn test",
     "clean": "rimraf lib",
+    "compose-changelog": "node ./scripts/compose-changelog.js",
     "download-cli": "node ./scripts/download-cli.js",
     "download-fwuploader": "node ./scripts/download-fwuploader.js",
     "copy-serial-plotter": "npx ncp ../node_modules/arduino-serial-plotter-webapp ./build/arduino-serial-plotter-webapp",
@@ -92,6 +93,7 @@
     "which": "^1.3.1"
   },
   "devDependencies": {
+    "@octokit/rest": "^18.12.0",
     "@types/chai": "^4.2.7",
     "@types/chai-string": "^1.4.2",
     "@types/mocha": "^5.2.7",

arduino-ide-extension/scripts/compose-changelog.js

@@ -0,0 +1,100 @@
+// @ts-check
+
+
+(async () => {
+  const { Octokit } = require('@octokit/rest');
+  const fs = require("fs");
+  const path = require("path");
+
+  const octokit = new Octokit({
+    userAgent: 'Arduino IDE compose-changelog.js',
+  });
+
+  const response = await octokit.rest.repos.listReleases({
+    owner: 'arduino',
+    repo: 'arduino-ide',
+  }).catch(err => {
+    console.error(err);
+    process.exit(1);
+  })
+
+  const releases = response.data;
+
+  let fullChangelog = releases.reduce((acc, item) => {
+    // Process each line separately
+    const body = item.body.split('\n').map(processLine).join('\n')
+    // item.name is the name of the release changelog
+    return acc + `# ${item.name}\n\n${body}\n\n---\n\n`;
+  }, '');
+
+  const changelogFile = path.resolve(process.argv[process.argv.length - 1]);
+
+  await fs.writeFile(
+    changelogFile,
+    fullChangelog,
+    {
+      flag: "w+",
+    },
+    err => {
+      if (err) {
+        console.error(err);
+        process.exit(1);
+      }
+      console.log("Changelog written to", changelogFile);
+    }
+  )
+})();
+
+
+// processLine applies different substitutions to line string.
+// We're assuming that there are no more than one substitution
+// per line to be applied.
+const processLine = (line) => {
+  // Check if a link with one of the following format exists:
+  // * [#123](https://github.com/arduino/arduino-ide/pull/123)
+  // * [#123](https://github.com/arduino/arduino-ide/issues/123)
+  // * [#123](https://github.com/arduino/arduino-ide/pull/123/)
+  // * [#123](https://github.com/arduino/arduino-ide/issues/123/)
+  // If it does return the line as is.
+  let r = /(\(|\[)#\d+(\)|\])(\(|\[)https:\/\/github\.com\/arduino\/arduino-ide\/(pull|issues)\/(\d+)\/?(\)|\])/gm;
+  if (r.test(line)) {
+    return line;
+  }
+
+  // Check if a issue or PR link with the following format exists:
+  // * #123
+  // If it does it's changed to:
+  // * [#123](https://github.com/arduino/arduino-ide/pull/123)
+  r = /#(\d+)/gm;
+  if (r.test(line)) {
+    return line.replace(r, `[#$1](https://github.com/arduino/arduino-ide/pull/$1)`)
+  }
+
+  // Check if a link with one of the following format exists:
+  // * https://github.com/arduino/arduino-ide/pull/123
+  // * https://github.com/arduino/arduino-ide/issues/123
+  // * https://github.com/arduino/arduino-ide/pull/123/
+  // * https://github.com/arduino/arduino-ide/issues/123/
+  // If it does it's changed respectively to:
+  // * [#123](https://github.com/arduino/arduino-ide/pull/123)
+  // * [#123](https://github.com/arduino/arduino-ide/issues/123)
+  // * [#123](https://github.com/arduino/arduino-ide/pull/123/)
+  // * [#123](https://github.com/arduino/arduino-ide/issues/123/)
+  r = /(https:\/\/github\.com\/arduino\/arduino-ide\/(pull|issues)\/(\d+)\/?)/gm;
+  if (r.test(line)) {
+    return line.replace(r, `[#$3]($1)`);
+  }
+
+  // Check if a link with the following format exists:
+  // * https://github.com/arduino/arduino-ide/compare/2.0.0-rc2...2.0.0-rc3
+  // * https://github.com/arduino/arduino-ide/compare/2.0.0-rc2...2.0.0-rc3/
+  // If it does it's changed to:
+  // * [`2.0.0-rc2...2.0.0-rc3`](https://github.com/arduino/arduino-ide/compare/2.0.0-rc2...2.0.0-rc3)
+  r = /(https:\/\/github\.com\/arduino\/arduino-ide\/compare\/([^\/]*))\/?\s?/gm;
+  if (r.test(line)) {
+    return line.replace(r, '[`$2`]($1)');;
+  }
+
+  // If nothing matches just return the line as is
+  return line;
+}

package.json

@@ -46,7 +46,8 @@
     "i18n:generate": "theia nls-extract -e vscode -f \"+(arduino-ide-extension|browser-app|electron|electron-app|plugins)/**/*.ts?(x)\" -o ./i18n/en.json",
     "i18n:check": "yarn i18n:generate && git add -N ./i18n && git diff --exit-code ./i18n",
     "i18n:push": "node ./scripts/i18n/transifex-push.js ./i18n/en.json",
-    "i18n:pull": "node ./scripts/i18n/transifex-pull.js ./i18n/"
+    "i18n:pull": "node ./scripts/i18n/transifex-pull.js ./i18n/",
+    "compose-changelog": "yarn --cwd ./arduino-ide-extension compose-changelog"
   },
   "lint-staged": {
     "./arduino-ide-extension/**/*.{ts,tsx}": [