chore: 🤖 document release process

.yarnrc.yml

@@ -1,4 +1,5 @@
 nmHoistingLimits: workspaces
+
 nodeLinker: node-modules
 
 plugins:
@@ -7,4 +8,4 @@ plugins:
   - path: .yarn/plugins/@yarnpkg/plugin-workspace-tools.cjs
     spec: "@yarnpkg/plugin-workspace-tools"
 
-yarnPath: .yarn/releases/yarn-3.0.1.cjs
+yarnPath: .yarn/releases/yarn-3.0.2.cjs

docs/RELEASE.md

@@ -0,0 +1,28 @@
+# Versioning and Release
+
+`Standard Version` is used to support the release process.
+The library generates a `changelog` based on the commit messages (uses `conventional-changelog`). See [standard-version](https://github.com/conventional-changelog/standard-version) for more details.
+
+Because this project is set up with `yarn workspaces`, a more custom process is required:
+
+- Each package is handled separately
+- Standard Version is called without creating new `tags` and `commits`
+
+# 🗂 Good to know
+
+## Squash commits when merging PRs?
+
+Yes, but keep in mind that one PR must only equal to one feature or fix.
+
+## Create a release
+
+1. Run tests: `yarn workspaces foreach -p run test:ci`
+2. Run `yarn workspaces foreach -p run release:prepare`
+3. Build base: `yarn workspace @porscheofficial/cookie-consent-banner run build`
+4. Build react: `yarn workspace @porscheofficial/cookie-consent-banner-react run build`
+5. Check `changelogs`
+6. Stage changes: `git add`
+7. Commit changes: `git cz --type release`
+8. Generate a new tag based on the updated version number (in sync between packages): `git tag -a v[version]`
+9. Push to GitHub
+10. Release packages to npm

package.json

@@ -4,17 +4,19 @@
     "packages/*"
   ],
   "scripts": {
+    "release:prepare": "echo \"Root doesn't have release:prepare defined.\"",
     "test:ci": "echo \"Root doesn't have any tests defined.\""
   },
   "devDependencies": {
-    "@types/node": "^16.9.0",
-    "@typescript-eslint/eslint-plugin": "^4.31.0",
-    "@typescript-eslint/parser": "^4.31.0",
+    "@types/node": "^16.10.2",
+    "@typescript-eslint/eslint-plugin": "^4.32.0",
+    "@typescript-eslint/parser": "^4.32.0",
     "eslint": "^7.32.0",
     "eslint-config-prettier": "^8.3.0",
     "eslint-plugin-prettier": "^4.0.0",
-    "eslint-plugin-react": "^7.25.1",
-    "prettier": "^2.4.0",
-    "typescript": "^4.4.2"
-  }
+    "eslint-plugin-react": "^7.26.1",
+    "prettier": "^2.4.1",
+    "typescript": "^4.4.3"
+  },
+  "packageManager": "[email protected]"
 }