Skip to content

Commit 7a347c4

Browse files
authored
[ruff] update the release process documentation (#20752)
1 parent 70b23a4 commit 7a347c4

File tree

1 file changed

+10
-3
lines changed

1 file changed

+10
-3
lines changed

CONTRIBUTING.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -321,10 +321,16 @@ them to [PyPI](https://pypi.org/project/ruff/).
321321
Ruff follows the [semver](https://semver.org/) versioning standard. However, as pre-1.0 software,
322322
even patch releases may contain [non-backwards-compatible changes](https://semver.org/#spec-item-4).
323323

324-
### Creating a new release
324+
### Installing tools
325325

326326
1. Install `uv`: `curl -LsSf https://astral.sh/uv/install.sh | sh`
327327

328+
1. Install `npm`: `brew install npm` or similar
329+
330+
### Creating a new release
331+
332+
Commit each step of this process separately for easier review.
333+
328334
1. Run `./scripts/release.sh`; this command will:
329335

330336
- Generate a temporary virtual environment with `rooster`
@@ -337,6 +343,7 @@ even patch releases may contain [non-backwards-compatible changes](https://semve
337343

338344
- Often labels will be missing from pull requests they will need to be manually organized into the proper section
339345
- Changes should be edited to be user-facing descriptions, avoiding internal details
346+
- Square brackets (eg, `[ruff]` project name) will be automatically escaped by `pre-commit`
340347

341348
Additionally, for minor releases:
342349

@@ -376,13 +383,13 @@ even patch releases may contain [non-backwards-compatible changes](https://semve
376383
377384
1. Verify the GitHub release:
378385
379-
1. The Changelog should match the content of `CHANGELOG.md`
380-
1. Append the contributors from the `scripts/release.sh` script
386+
1. The changelog should match the content of `CHANGELOG.md`
381387
382388
1. If needed, [update the schemastore](https://github.com/astral-sh/ruff/blob/main/scripts/update_schemastore.py).
383389
384390
1. One can determine if an update is needed when
385391
`git diff old-version-tag new-version-tag -- ruff.schema.json` returns a non-empty diff.
392+
1. Run `uv run --only-dev --no-sync scripts/update_schemastore.py --proto <https|ssh>`
386393
1. Once run successfully, you should follow the link in the output to create a PR.
387394
388395
1. If needed, update the [`ruff-lsp`](https://github.com/astral-sh/ruff-lsp) and

0 commit comments

Comments
 (0)