Auto changelog release (#199)

* Removes unwanted bind call and add a test

* Added changelog automatic support

* Update contributing guide for release

* Revert unwanted fixes for this PR

.github/workflows/create-bump-version-pr.yml

@@ -29,6 +29,10 @@ jobs:
           cd projects/ngx-maplibre-gl/
           npm version --commit-hooks false --git-tag-version false ${{ inputs.version }}
 
+      - name: Update CHANGELOG.md
+        run: |
+          npm run changelog
+
       - name: Create Pull Request
         uses: peter-evans/create-pull-request@v5
         with:

CHANGELOG.md

@@ -2,6 +2,8 @@
 
 All notable changes to this project will be documented in this file.
 
+<!-- auto-changelog-above -->
+
 ### [18.1.1](https://github.com/maplibre/ngx-maplibre-gl/compare/v18.1.0...v18.1.1) (2024-08-27)
 
 - Fix an issue related to clustering caused by the signals migration: [#188](https://github.com/maplibre/ngx-maplibre-gl/issues/188)

CONTRIBUTING.md

@@ -30,16 +30,10 @@ https://github.com/angular/angular/blob/master/CONTRIBUTING.md#commit
 
 ## Release a new version
 
-IMPORTANT: ngx-maplibre-gl does not follow - It uses the main version of angular as the major and usualy the maplibre-gl version as the minor.
+IMPORTANT: ngx-maplibre-gl does not follow semver - It uses the main version of angular as the major and usualy the maplibre-gl version as the minor.
 
-Check if tests are OK (`npm run test` and `npm run e2e` or take a look at ci if your changes are pushed).
+Run the create-bump-version-PR workflow to update the version and changelog.
 
-Change the version in both package.json files - the version should match the supported angular version
-
-Manually edit `CHANGELOG.md` if necessary.
-
-If everything is OK, push the changes
-
-Run the create-bump-version-PR workflow to update the version
+Manually edit `CHANGELOG.md` to add the new version name and release data, also edit the version content if needed.
 
 Once merged to main, a new version should be created automatically.

package.json

@@ -1,6 +1,10 @@
 {
   "name": "ngx-maplibre-gl-srcs",
   "version": "18.1.1",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/maplibre/ngx-maplibre-gl.git"
+  },
   "scripts": {
     "ng": "ng",
     "start": "ng serve showcase",
@@ -13,7 +17,8 @@
     "e2e": "ng run showcase:cypress-run",
     "cypress:open": "ng run showcase:cypress-open",
     "docs": "typedoc",
-    "serve:ssr:showcase": "node dist/showcase/server/server.mjs"
+    "serve:ssr:showcase": "node dist/showcase/server/server.mjs",
+    "changelog": "auto-changelog --unreleased-only"
   },
   "private": true,
   "engines": {
@@ -63,6 +68,7 @@
     "@typescript-eslint/eslint-plugin": "^8.2.0",
     "@typescript-eslint/parser": "^8.2.0",
     "angular-cli-ghpages": "^2.0.1",
+    "auto-changelog": "^2.5.0",
     "commitizen": "^4.3.0",
     "cypress": "^13.13.3",
     "eslint": "^8.57.0",