@wmde/eslint-config-wikimedia-typescript 0.2.9 → 0.2.10

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 (2) hide show
  1. package/README.md +27 -0
  2. package/package.json +5 -5
package/README.md CHANGED
@@ -1,3 +1,30 @@
1
1
  # eslint-config-wikimedia-typescript
2
2
 
3
3
  ESLint config for TypeScript following [Wikimedia code conventions](https://www.npmjs.com/package/eslint-config-wikimedia) - the idea is to make this repository here obsolete in the medium term and upstream these rules.
4
+
5
+ ## Release instructions
6
+
7
+ To make a new release:
8
+
9
+ 1. Bump the version number in a pull request.
10
+ (Edit `package.json` manually, then run `npm install` to update the version number in `package-lock.json`.)
11
+ The usual commit message is “Bump version to <var>1.2.3</var>”.
12
+ [Example pull request](https://github.com/wmde/eslint-config-wikimedia-typescript/pull/48).
13
+
14
+ 1. Get that pull request reviewed and merged.
15
+
16
+ 1. Tag the merge commit locally. A “lightweight” tag is usually enough:
17
+ `git pull`, then <code>git tag v<var>1.2.3</var></code>.
18
+
19
+ 1. Push the tag. <code>git push origin v<var>1.2.3</var></code>
20
+
21
+ 1. Turn it into a proper release on GitHub:
22
+ [draft a new release](https://github.com/wmde/eslint-config-wikimedia-typescript/releases/new).
23
+ [Example release](https://github.com/wmde/eslint-config-wikimedia-typescript/releases/tag/v0.2.9).
24
+
25
+ 1. Once the GitHub release is published,
26
+ it should be automatically published to NPM via GitHub Actions.
27
+
28
+ 1. Submit a Gitlab change to `ci-tools/libup-config`
29
+ to update the version of the package in `releases.json`.
30
+ ([Source](https://gitlab.wikimedia.org/repos/ci-tools/libup-config/-/commit/62e275576794ccdbf82b7cef2bf5cdd629d9b60c); replace with an example once available.)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@wmde/eslint-config-wikimedia-typescript",
3
- "version": "0.2.9",
3
+ "version": "0.2.10",
4
4
  "description": "ESLint config for TypeScript following Wikimedia code conventions.",
5
5
  "main": "typescript.js",
6
6
  "scripts": {
@@ -27,11 +27,11 @@
27
27
  ],
28
28
  "devDependencies": {
29
29
  "eslint": "^8.57.0",
30
- "eslint-config-wikimedia": "^0.27.0"
30
+ "eslint-config-wikimedia": "^0.28.2"
31
31
  },
32
32
  "peerDependencies": {
33
- "@typescript-eslint/eslint-plugin": "^7.5.0",
34
- "@typescript-eslint/parser": "^7.5.0",
35
- "eslint-config-wikimedia": "^0.27.0"
33
+ "@typescript-eslint/eslint-plugin": "^8.0.1",
34
+ "@typescript-eslint/parser": "^8.0.1",
35
+ "eslint-config-wikimedia": "^0.28.2"
36
36
  }
37
37
  }