Merge pull request #19 from lacrypta/use-changelog-instead-of-readme

Move changelog to its own file
Gerrit0 · May 24, 2024 · 65fc1fd · 65fc1fd
2 parents 146b456 + d8ce08a
commit 65fc1fd
Show file tree

Hide file tree

Showing 3 changed files with 169 additions and 166 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,163 @@
+# Changelog
+
+## v3.1.26 (2024-05-19)
+
+-   Updated MDN API index with @mdn/browser-compat-data version 5.5.29
+
+## v3.1.25 (2024-05-12)
+
+-   Updated MDN API index with @mdn/browser-compat-data version 5.5.27
+
+## v3.1.24 (2024-05-05)
+
+-   Updated MDN API index with @mdn/browser-compat-data version 5.5.25
+
+## v3.1.23 (2024-04-28)
+
+-   Updated MDN API index with @mdn/browser-compat-data version 5.5.23
+
+## v3.1.22 (2024-04-21)
+
+-   Updated MDN API index with @mdn/browser-compat-data version 5.5.22
+
+## v3.1.21 (2024-04-14)
+
+-   Updated MDN API index with @mdn/browser-compat-data version 5.5.21
+
+## v3.1.20 (2024-04-10)
+
+-   Added `NoInfer` link resolution for TypeScript utility types (@xuhdev)
+
+## v3.1.19 (2024-03-31)
+
+-   Updated MDN API index with @mdn/browser-compat-data version 5.5.18
+
+## v3.1.18 (2024-03-10)
+
+-   Updated MDN API index with @mdn/browser-compat-data version 5.5.14
+
+## v3.1.17 (2024-02-25)
+
+-   Updated MDN API index with @mdn/browser-compat-data version 5.5.11
+
+## v3.1.16 (2024-02-11)
+
+-   Updated MDN API index with @mdn/browser-compat-data version 5.5.10
+
+## v3.1.15 (2024-02-04)
+
+-   Updated MDN API index with @mdn/browser-compat-data version 5.5.9
+
+## v3.1.14 (2024-01-28)
+
+-   Updated MDN API index with @mdn/browser-compat-data version 5.5.8
+
+## v3.1.13 (2024-01-21)
+
+-   Updated MDN API index with @mdn/browser-compat-data version 5.5.7
+
+## v3.1.12 (2024-01-14)
+
+-   Updated MDN API index with @mdn/browser-compat-data version 5.5.6
+
+## v3.1.11 (2024-01-07)
+
+-   Updated MDN API index with @mdn/browser-compat-data version 5.5.4
+
+## v3.1.10 (2023-12-31)
+
+-   Updated MDN API index with @mdn/browser-compat-data version 5.5.3
+
+## v3.1.9 (2023-12-24)
+
+-   Updated MDN API index with @mdn/browser-compat-data version 5.5.2
+
+## v3.1.8 (2023-12-17)
+
+-   Updated MDN API index with @mdn/browser-compat-data version 5.5.0
+
+## v3.1.7 (2023-12-10)
+
+-   Updated MDN API index with @mdn/browser-compat-data version 5.4.5
+
+## v3.1.6 (2023-12-03)
+
+-   Updated MDN API index with @mdn/browser-compat-data version 5.4.3
+
+## v3.1.5 (2023-11-26)
+
+-   Updated MDN API index with @mdn/browser-compat-data version 5.4.1
+
+## v3.1.4 (2023-11-19)
+
+-   Updated MDN API index
+
+## v3.1.3 (2023-11-18)
+
+-   Fixed broken publish due to missing data folder, #14.
+
+## v3.1.2 (2023-11-18)
+
+-   Updated MDN API index
+
+## v3.1.1 (2023-11-18)
+
+-   Updated MDN API index
+-   Fixed links to types defined in `@types/web`, #13
+
+## v3.1.0 (2023-08-25)
+
+-   Added support for TypeDoc 0.25.x.
+
+## v3.0.2 (2023-03-09)
+
+-   Add support for resolving TypeScript utility types (`Partial`, `Omit`, etc.) to links on the TypeScript website.
+    This can be turned off with the new `resolveUtilityTypes` option.
+
+## v3.0.2 (2023-03-10)
+
+-   Fixed invalid published package (@WikiRik)
+
+## v3.0.1 (2023-03-09)
+
+-   Add support for `{@link !NaN}` to link to global symbols, #4
+-   Fix links to Intl/WebAssembly namespace members
+-   In TypeDoc versions 0.23.26 and later will now use the symbol name as the default link test
+
+## v3.0.0 (2023-03-09)
+
+-   Add support for TypeDoc 0.24 (@ocavue)
+-   Drop support for TypeDoc 0.22
+
+## v2.0.2 (2022-12-22)
+
+-   Add missing `AsyncGenerator` and `AsyncGeneratorFunction` pages (@achingbrain)
+
+## v2.0.1 (2022-12-16)
+
+-   Add many missing links (@achingbrain)
+
+## v2.0.0 (2022-06-26)
+
+-   Support TypeDoc 0.23
+-   Drop support for Node 12
+
+## v1.0.6 (2022-04-09)
+
+-   Added support for WebAudio and Canvas APIs (@johh)
+
+## v1.0.5 (2022-01-26)
+
+-   Fixed repository reference so that npm will link to GitHub (@mikaello)
+
+## v1.0.4 (2021-09-05)
+
+-   Added missing link for base `HTMLElement` interface.
+
+## v1.0.3 (2021-09-05)
+
+-   Added support for HTML element types (`HTMLAnchorElement`, `HTMLButtonElement`, etc.)
+
+## v1.0.2 (2021-09-05)
+
+-   Added `typedocplugin` to keywords so that TypeDoc will now automatically load this plugin if installed.
diff --git a/README.md b/README.md
@@ -15,164 +15,4 @@ Supports TypeDoc 0.23.x, 0.24.x and 0.25.x
 
 ## Changelog
 
-### v3.1.26 (2024-05-19)
-
--   Updated MDN API index with @mdn/browser-compat-data version 5.5.29
-
-### v3.1.25 (2024-05-12)
-
--   Updated MDN API index with @mdn/browser-compat-data version 5.5.27
-
-### v3.1.24 (2024-05-05)
-
--   Updated MDN API index with @mdn/browser-compat-data version 5.5.25
-
-### v3.1.23 (2024-04-28)
-
--   Updated MDN API index with @mdn/browser-compat-data version 5.5.23
-
-### v3.1.22 (2024-04-21)
-
--   Updated MDN API index with @mdn/browser-compat-data version 5.5.22
-
-### v3.1.21 (2024-04-14)
-
--   Updated MDN API index with @mdn/browser-compat-data version 5.5.21
-
-### v3.1.20 (2024-04-10)
-
--   Added `NoInfer` link resolution for TypeScript utility types (@xuhdev)
-
-### v3.1.19 (2024-03-31)
-
--   Updated MDN API index with @mdn/browser-compat-data version 5.5.18
-
-### v3.1.18 (2024-03-10)
-
--   Updated MDN API index with @mdn/browser-compat-data version 5.5.14
-
-### v3.1.17 (2024-02-25)
-
--   Updated MDN API index with @mdn/browser-compat-data version 5.5.11
-
-### v3.1.16 (2024-02-11)
-
--   Updated MDN API index with @mdn/browser-compat-data version 5.5.10
-
-### v3.1.15 (2024-02-04)
-
--   Updated MDN API index with @mdn/browser-compat-data version 5.5.9
-
-### v3.1.14 (2024-01-28)
-
--   Updated MDN API index with @mdn/browser-compat-data version 5.5.8
-
-### v3.1.13 (2024-01-21)
-
--   Updated MDN API index with @mdn/browser-compat-data version 5.5.7
-
-### v3.1.12 (2024-01-14)
-
--   Updated MDN API index with @mdn/browser-compat-data version 5.5.6
-
-### v3.1.11 (2024-01-07)
-
--   Updated MDN API index with @mdn/browser-compat-data version 5.5.4
-
-### v3.1.10 (2023-12-31)
-
--   Updated MDN API index with @mdn/browser-compat-data version 5.5.3
-
-### v3.1.9 (2023-12-24)
-
--   Updated MDN API index with @mdn/browser-compat-data version 5.5.2
-
-### v3.1.8 (2023-12-17)
-
--   Updated MDN API index with @mdn/browser-compat-data version 5.5.0
-
-### v3.1.7 (2023-12-10)
-
--   Updated MDN API index with @mdn/browser-compat-data version 5.4.5
-
-### v3.1.6 (2023-12-03)
-
--   Updated MDN API index with @mdn/browser-compat-data version 5.4.3
-
-### v3.1.5 (2023-11-26)
-
--   Updated MDN API index with @mdn/browser-compat-data version 5.4.1
-
-### v3.1.4 (2023-11-19)
-
--   Updated MDN API index
-
-### v3.1.3 (2023-11-18)
-
--   Fixed broken publish due to missing data folder, #14.
-
-### v3.1.2 (2023-11-18)
-
--   Updated MDN API index
-
-### v3.1.1 (2023-11-18)
-
--   Updated MDN API index
--   Fixed links to types defined in `@types/web`, #13
-
-### v3.1.0 (2023-08-25)
-
--   Added support for TypeDoc 0.25.x.
-
-### v3.0.2 (2023-03-09)
-
--   Add support for resolving TypeScript utility types (`Partial`, `Omit`, etc.) to links on the TypeScript website.
-    This can be turned off with the new `resolveUtilityTypes` option.
-
-### v3.0.2 (2023-03-10)
-
--   Fixed invalid published package (@WikiRik)
-
-### v3.0.1 (2023-03-09)
-
--   Add support for `{@link !NaN}` to link to global symbols, #4
--   Fix links to Intl/WebAssembly namespace members
--   In TypeDoc versions 0.23.26 and later will now use the symbol name as the default link test
-
-### v3.0.0 (2023-03-09)
-
--   Add support for TypeDoc 0.24 (@ocavue)
--   Drop support for TypeDoc 0.22
-
-### v2.0.2 (2022-12-22)
-
--   Add missing `AsyncGenerator` and `AsyncGeneratorFunction` pages (@achingbrain)
-
-### v2.0.1 (2022-12-16)
-
--   Add many missing links (@achingbrain)
-
-### v2.0.0 (2022-06-26)
-
--   Support TypeDoc 0.23
--   Drop support for Node 12
-
-### v1.0.6 (2022-04-09)
-
--   Added support for WebAudio and Canvas APIs (@johh)
-
-### v1.0.5 (2022-01-26)
-
--   Fixed repository reference so that npm will link to GitHub (@mikaello)
-
-### v1.0.4 (2021-09-05)
-
--   Added missing link for base `HTMLElement` interface.
-
-### v1.0.3 (2021-09-05)
-
--   Added support for HTML element types (`HTMLAnchorElement`, `HTMLButtonElement`, etc.)
-
-### v1.0.2 (2021-09-05)
-
--   Added `typedocplugin` to keywords so that TypeDoc will now automatically load this plugin if installed.
+See full changelog [here](./CHANGELOG.md).
diff --git a/scripts/commit_web_api_changes.sh b/scripts/commit_web_api_changes.sh
@@ -9,7 +9,7 @@ if ! git diff --exit-code data/web-api.json >/dev/null; then
 
 extra=$"\
 \n\
-### $version ($(date '+%Y-%m-%d'))\n\
+## $version ($(date '+%Y-%m-%d'))\n\
 \n\
 -   Updated MDN API index with @mdn/browser-compat-data version $compat_version\n\
 "
@@ -19,14 +19,14 @@ extra=$"\
             printf(\"$extra\")
             modif = 0
         }
-        /^## Changelog/ && !modif {
+        /^# Changelog/ && !modif {
             modif = 1
         }
         {print}
-    " README.md > README2.md
-    mv README2.md README.md
+    " CHANGELOG.md > CHANGELOG2.md
+    mv CHANGELOG2.md CHANGELOG.md
 
-    git add README.md ./package.json ./package-lock.json ./data/web-api.json
+    git add CHANGELOG.md ./package.json ./package-lock.json ./data/web-api.json
     git commit -m "[github-actions] Update Web API Index";
     git push
 else