@maggioli-rd/sr-codeowners-plugin 1.3.0 → 1.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/CHANGELOG.md +14 -0
  2. package/README.md +50 -1
  3. package/package.json +5 -5
package/CHANGELOG.md CHANGED
@@ -1,3 +1,17 @@
1
+ # [1.5.0](https://gitlab.com/maggiolispa/ricerca-sviluppo/semantic-release-shareable-configurations/sr-codeowners-plugin/compare/v1.4.0...v1.5.0) (2024-01-16)
2
+
3
+
4
+ ### Features
5
+
6
+ * **deps:** update typescript-eslint monorepo from 6.18.1 to 6.19.0 ([57457d2](https://gitlab.com/maggiolispa/ricerca-sviluppo/semantic-release-shareable-configurations/sr-codeowners-plugin/commit/57457d283d03edd84e0c7a48ebae9543f8d72a11))
7
+
8
+ # [1.4.0](https://gitlab.com/maggiolispa/ricerca-sviluppo/semantic-release-shareable-configurations/sr-codeowners-plugin/compare/v1.3.0...v1.4.0) (2024-01-15)
9
+
10
+
11
+ ### Features
12
+
13
+ * **deps:** update vitest monorepo from 1.1.3 to 1.2.0 ([b36c1f3](https://gitlab.com/maggiolispa/ricerca-sviluppo/semantic-release-shareable-configurations/sr-codeowners-plugin/commit/b36c1f30bf7a0267a73bc3e8dc84899cf7b1d281))
14
+
1
15
  # [1.3.0](https://gitlab.com/maggiolispa/ricerca-sviluppo/semantic-release-shareable-configurations/sr-codeowners-plugin/compare/v1.2.2...v1.3.0) (2024-1-9)
2
16
 
3
17
 
package/README.md CHANGED
@@ -19,7 +19,56 @@
19
19
  | `limit` | Number of authors obtained from the ranking of authors with the most commits. | 3 |
20
20
  | `leaderboard` | Generates the ranking of authors with the most commits and includes it as a comment in the CODEOWNERS file. | true |
21
21
 
22
- ## Links
22
+ ## Install
23
+
24
+ ```bash
25
+ $ npm install @maggioli-rd/sr-codeowners-plugin -D
26
+ ```
27
+
28
+ ## Usage
29
+
30
+ The plugin can be configured in the [**semantic-release** configuration file](https://github.com/semantic-release/semantic-release/blob/master/docs/usage/configuration.md#configuration):
31
+
32
+ ```json
33
+ {
34
+ "plugins": [
35
+ "@semantic-release/commit-analyzer",
36
+ "@semantic-release/release-notes-generator",
37
+ ["@semantic-release/git", {
38
+ "assets": [
39
+ "CHANGELOG.md",
40
+ "pubspec.yaml",
41
+ "CODEOWNERS"
42
+ ],
43
+ "message": "chore(release): ${nextRelease.version}\n\n${nextRelease.notes}"
44
+ }],
45
+ ["@maggioli-rd/sr-codeowners-plugin", {
46
+ "excludeRegex": "semantic-release-bot",
47
+ "codeownersPath": "CODEOWNERS",
48
+ "limit": 2
49
+ }]
50
+ ]
51
+ }
52
+ ```
53
+
54
+ ### Shareable-Configuration Extension Example (release.config.js)
55
+ ```javascript
56
+ var config = require('@maggioli-rd/semantic-release-flutter');
57
+ var gitPluginIndex = config.plugins.findIndex((plugin) => plugin.includes("@semantic-release/git"))
58
+
59
+ config.plugins[gitPluginIndex][1]["assets"].push(".gitlab/CODEOWNERS")
60
+
61
+ config.plugins.push(
62
+ ["@maggioli-rd/sr-codeowners-plugin", {
63
+ "excludeRegex": "RenovateBot|semantic-release-bot",
64
+ "limit": 5,
65
+ "header": "My personal header"
66
+ }]
67
+ )
68
+ module.exports = config
69
+ ```
70
+
71
+ ## Resources
23
72
 
24
73
  * [https://semantic-release.gitbook.io/semantic-release/](https://semantic-release.gitbook.io/semantic-release/)
25
74
  * [https://semantic-release.gitbook.io/semantic-release/developer-guide/plugin](https://semantic-release.gitbook.io/semantic-release/developer-guide/plugin)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maggioli-rd/sr-codeowners-plugin",
3
- "version": "1.3.0",
3
+ "version": "1.5.0",
4
4
  "description": "Maggioli Semantic Release Plugin: Codeowners",
5
5
  "files": [
6
6
  "dist/*"
@@ -40,9 +40,9 @@
40
40
  "@types/semantic-release": "20.0.6",
41
41
  "@types/semantic-release__error": "3.0.3",
42
42
  "@types/signale": "1.4.7",
43
- "@typescript-eslint/eslint-plugin": "6.18.1",
44
- "@typescript-eslint/parser": "6.18.1",
45
- "@vitest/coverage-v8": "1.1.3",
43
+ "@typescript-eslint/eslint-plugin": "6.19.0",
44
+ "@typescript-eslint/parser": "6.19.0",
45
+ "@vitest/coverage-v8": "1.2.0",
46
46
  "eslint": "8.56.0",
47
47
  "eslint-config-prettier": "9.1.0",
48
48
  "eslint-config-semistandard": "17.0.0",
@@ -52,7 +52,7 @@
52
52
  "eslint-plugin-promise": "6.1.1",
53
53
  "semantic-release": "22.0.12",
54
54
  "typescript": "5.3.3",
55
- "vitest": "1.1.3",
55
+ "vitest": "1.2.0",
56
56
  "vitest-mock-extended": "1.3.1"
57
57
  },
58
58
  "scripts": {