Andreas/markdownlint
1
0
Fork 0
mirror of https://github.com/DavidAnson/markdownlint.git synced 2025-09-21 21:30:47 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 5

Add ReleaseProcess.md to explain the release process (fixes #562).

Browse source
This commit is contained in:
David Anson 2022-12-13 16:42:54 -08:00
parent 3ebfdd5157
commit c9f7a323cc
3 changed files with 25 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

20
doc/ReleaseProcess.md Normal file
View file

@ -0,0 +1,20 @@
# Release Process
The `markdownlint` library has some related dependencies that are updated along
with it. To prevent possible regressions from having a widespread impact, these
releases are separated by a few days to provide an opportunity to find issues.
1. [`markdownlint`][markdownlint]
2. [`markdownlint-cli2`][markdownlint-cli2]
3. [`markdownlint-cli2-action`][markdownlint-cli2-action]
4. [`vscode-markdownlint`][vscode-markdownlint]
5. [`markdownlint-cli`][markdownlint-cli]
This sequence is not strict and may be adjusted based on the content of the
release and the scope of feature work in each dependency.
[markdownlint]: https://github.com/DavidAnson/markdownlint
[markdownlint-cli2]: https://github.com/DavidAnson/markdownlint-cli2
[markdownlint-cli2-action]: https://github.com/marketplace/actions/markdownlint-cli2-action
[vscode-markdownlint]: https://marketplace.visualstudio.com/items?itemName=DavidAnson.vscode-markdownlint
[markdownlint-cli]: https://github.com/igorshubovych/markdownlint-cli