Fix automatically generated release notes too long problem

Signed-off-by: Laszlo Kiraly <laszlo.kiraly@est.tech>

.github/workflows/release.yaml

@@ -17,10 +17,30 @@ jobs:
           branch=${{github.event.workflow_run.head_branch}}
           echo tag=${branch#release/} >> $GITHUB_OUTPUT
         id: get-tag-step
+  get-rel-notes:
+    name: Get release notes
+    needs: get-tag
+    runs-on: ubuntu-latest
+    outputs:
+      notes: ${{ steps.generate-release-notes.outputs.notes }}
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+            repository: networkservicemesh/.github
+            path: github
+      - name: Install node modules
+        run: yarn add @actions/github
+      - name: Generate Release Notes
+        id: generate-release-notes
+        run: |
+            ls -ltr github/scripts
+            node github/scripts/generate-release-notes.js '${{ secrets.token }}' '${{ needs.get-tag.outputs.tag }}' '${{ github.event.repository.name }}' > notes.txt
+            "::set-output name=notes::$(cat notes.txt)"
 
   create-release:
     name: Create release
-    needs: get-tag
+    needs: [get-tag, get-rel-notes]
     runs-on: ubuntu-latest
     steps:
       - name: Choose branch
@@ -38,14 +58,13 @@ jobs:
         uses: actions/checkout@v4
         with:
           ref: refs/heads/${{ steps.branch.outputs.branch }}
-
       - name: Push tag ${{ needs.get-tag.outputs.tag }}
         run: |
           git status
           git tag ${{ needs.get-tag.outputs.tag }}
           git push origin ${{ needs.get-tag.outputs.tag }} -f
       - name: Create release ${{ needs.get-tag.outputs.tag }}
         run: |
-          gh release create ${{ needs.get-tag.outputs.tag }} --title ${{ needs.get-tag.outputs.tag }} --target ${{github.event.workflow_run.head_branch}} --generate-notes
+          gh release create ${{ needs.get-tag.outputs.tag }} --repo ${{ github.event.repository }} --title ${{ needs.get-tag.outputs.tag }} --target ${{github.event.workflow_run.head_branch}} --notes ${{ needs.get-rel-notes.outputs.notes }}
         env:
           GH_TOKEN: ${{ secrets.token }}

scripts/generate-release-notes.js

@@ -0,0 +1,73 @@
+// ./tools/scripts/generate-release-notes.js
+
+const github = require('@actions/github');
+
+/**
+ * Generates the release notes for a github release.
+ *
+ * Arguments:
+ * 1 - github_token
+ * 2 - new version
+ */
+const token = process.argv[2];
+const version = process.argv[3];
+const repo = process.argv[4];
+
+async function main() {
+  const client = github.getOctokit(token);
+
+  const latestReleaseResponse = await client.request(
+    'GET /repos/{owner}/{repo}/releases/latest',
+    {
+      owner: 'networkservicemesh',
+      repo: repo,
+      headers: {
+        'X-GitHub-Api-Version': '2022-11-28',
+      },
+    }
+  );
+  const previousTag = latestReleaseResponse.data?.tag_name;
+
+  const response = await client.request(
+    'POST /repos/{owner}/{repo}/releases/generate-notes',
+    {
+      owner: 'networkservicemesh',
+      repo: repo,
+      tag_name: version,
+      previous_tag_name: previousTag,
+      headers: {
+        'X-GitHub-Api-Version': '2022-11-28',
+      },
+    }
+  );
+
+  const noteSections = response.data.body?.split('\n\n');
+  const trimmedSections = [];
+  const githubNotesMaxCharLength = 125000;
+  const maxSectionLength = githubNotesMaxCharLength / noteSections.length;
+  for (let i = 0; i < noteSections.length; i++) {
+    if (noteSections[i].length > githubNotesMaxCharLength) {
+      const lastLineIndex =
+        noteSections[i].substring(0, maxSectionLength).split('\n').length - 1;
+      const trimmed =
+        noteSections[i]
+          .split('\n')
+          .slice(0, lastLineIndex - 1)
+          .join('\n') +
+        `\n... (+${
+          noteSections[i].split('\n').length - (lastLineIndex + 1)
+        } others)`;
+      trimmedSections.push(trimmed);
+      continue;
+    }
+
+    trimmedSections.push(noteSections[i]);
+  }
+
+  console.log(trimmedSections.join('\n\n'));
+}
+
+main().catch((e) => {
+  console.error(`Failed generating release notes with error: ${e}`);
+  process.exit(0);
+});