feat: autogenerate package list in README (#3109)

Author: griest024

.github/workflows/release-please.yml

@@ -8,9 +8,31 @@ on:
 jobs:
   release-please:
     runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node: [18.19.x]
     steps:
+      - uses: graycoreio/github-actions/setup-node@main
+        with:
+          node-version: ${{ matrix.node }}
+          use-stamp-cache: true
+
       - uses: google-github-actions/release-please-action@v3
         with:
           token: ${{ secrets.GRAYCORE_GITHUB_TOKEN }}
           command: manifest
           default-branch: develop
+
+      - uses: actions/checkout@v4
+        with:
+          ref: release-please--branches--develop--components--daffodil
+
+      - name: Add Packages to README
+        run: |
+          git config user.email "[email protected]"
+          git config user.name "Github CI"
+          cd tools/release
+          npx gulp addPackagesToReadme
+          git add README.md
+          git commit -m 'docs: autogenerate package table in README' || true
+          git push

README.md

@@ -73,6 +73,7 @@
     "@types/jasmine": "~3.6.0",
     "@types/jasminewd2": "~2.0.8",
     "@types/node": "18.19.8",
+    "@types/through2": "^2.0.41",
     "@typescript-eslint/eslint-plugin": "^8.0.0",
     "@typescript-eslint/parser": "^8.0.0",
     "dgeni": "^0.4.14",
@@ -86,6 +87,8 @@
     "eslint-plugin-prefer-arrow": "^1.2.3",
     "gulp": "^4.0.2",
     "gulp-execa": "^1.1.0",
+    "gulp-reduce-async": "^1.0.0",
+    "gulp-replace": "^1.1.4",
     "highlight.js": "^11.9.0",
     "jasmine": "^4.6.0",
     "jasmine-core": "^4.6.0",

package-lock.json

@@ -1,3 +1,3 @@
-import * as minimist from 'minimist';
+import minimist from 'minimist';
 
 export const ARGS = minimist(process.argv.slice(2));

package.json

@@ -1,5 +1,5 @@
 import { series } from 'gulp';
-import * as git from 'simple-git/promise';
+import git from 'simple-git/promise';
 
 import { ARGS } from '../args/args';
 import { ARG as GIT_REMOTE_ARG } from '../args/git-remote';

tools/release/args/args.ts

@@ -1,11 +1,13 @@
+import { series } from 'gulp';
+import git from 'simple-git/promise';
 import * as standardVersion from 'standard-version';
-import * as git from 'simple-git/promise';
+
 import { RELEASE_CONFIG } from '../config';
-import { series } from 'gulp'; 
+
 
 const stageAll = async (): Promise<void> => {
-    await git(RELEASE_CONFIG.PROJECT_PATH).add('.');
-}
+  await git(RELEASE_CONFIG.PROJECT_PATH).add('.');
+};
 
 const generateCommit = () => standardVersion({
   noVerify: true,
@@ -19,12 +21,12 @@ const generateCommit = () => standardVersion({
   packageFiles: [
     RELEASE_CONFIG.PROJECT_PATH + '/package.json',
   ],
-  bumpFiles: []
+  bumpFiles: [],
 }).catch(err => {
-    console.error(`standard-version failed with message: ${err.message}`)
+  console.error(`standard-version failed with message: ${err.message}`);
 });
 
 export const commitChangelogAndTag = series(
   stageAll,
-  generateCommit
-)
+  generateCommit,
+);

tools/release/cleanup/cleanup.ts

@@ -9,6 +9,7 @@ import { prepare } from './prepare/prepare';
 import { publish } from './publish/publish';
 import { leafVersion } from './version/leaf-version';
 import { version } from './version/version';
+export { addPackagesToReadme } from './packages/add-packages-to-readme';
 
 export const release = series(
   prepare,