chore: Make sure our changelog.md file conforms with the format for C…

…hangelog ingestion for the Developer Portal

.github/workflows/main.yml

@@ -14,6 +14,19 @@ env:
   wasm-tools_version: 1.0.28
 
 jobs:
+
+  check-changelog:
+    if: github.ref != 'refs/heads/main'
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+    - uses: actions/setup-node@v3
+      with:
+        node-version: ${{ matrix.node-version }}
+        cache: 'yarn'
+    - run: yarn install --immutable
+    - run: npm run check-changelog
+
   build:
     name: Build
     needs: [ensure_cargo_installs]
@@ -150,6 +163,7 @@ jobs:
     - uses: actions/setup-node@v3
       with:
         node-version: 19
+        cache: 'yarn'
 
     - name: Download Engine
       uses: actions/download-artifact@v3
@@ -246,6 +260,7 @@ jobs:
     - uses: actions/setup-node@v3
       with:
         node-version: 19
+        cache: 'yarn'
 
     - name: Set up Fastly CLI
       uses: fastly/compute-actions/setup@v4
@@ -342,6 +357,7 @@ jobs:
     - uses: actions/setup-node@v3
       with:
         node-version: ${{ matrix.node-version }}
+        cache: 'yarn'
     - name: Download Engine
       uses: actions/download-artifact@v3
       with:

.gitignore

@@ -22,3 +22,4 @@ docs-app/pkg/*.tar.gz
 c-dependencies/js-compute-runtime/fastly-world/fastly_world_component_type.o
 
 *.a
+yarn-error.log

package.json

@@ -32,11 +32,13 @@
     "test:cli": "brittle --bail integration-tests/cli/**.test.js",
     "test:types": "tsd",
     "build": "make -j8 -C c-dependencies/js-compute-runtime && cp c-dependencies/js-compute-runtime/*.wasm c-dependencies/js-compute-runtime/fastly.wit .",
-    "build:debug": "DEBUG=true make -j8 -C c-dependencies/js-compute-runtime && cp c-dependencies/js-compute-runtime/*.wasm c-dependencies/js-compute-runtime/fastly.wit ."
+    "build:debug": "DEBUG=true make -j8 -C c-dependencies/js-compute-runtime && cp c-dependencies/js-compute-runtime/*.wasm c-dependencies/js-compute-runtime/fastly.wit .",
+    "check-changelog": "cae-release-notes-format-checker CHANGELOG.md"
   },
   "devDependencies": {
     "@jakechampion/cli-testing-library": "^1.0.0",
     "brittle": "^3.1.1",
+    "cae-release-notes-format-checker": "^1.0.0",
     "eslint": "^8.28.0",
     "get-bin-path": "^7.2.1",
     "tsd": "^0.25.0",