From c9f7a323cc2223081743871a4e3260871e2551a3 Mon Sep 17 00:00:00 2001
From: David Anson <david@dlaa.me>
Date: Tue, 13 Dec 2022 16:42:54 -0800
Subject: [PATCH] Add ReleaseProcess.md to explain the release process (fixes
 #562).

---
 README.md                 |  4 ++++
 doc/ReleaseProcess.md     | 20 ++++++++++++++++++++
 test/markdownlint-test.js |  1 +
 3 files changed, 25 insertions(+)
 create mode 100644 doc/ReleaseProcess.md

diff --git a/README.md b/README.md
index ec41183f..81935e4f 100644
--- a/README.md
+++ b/README.md
@@ -1032,6 +1032,10 @@ following projects or one of the tools in the [Related section](#related):
 
 See [CONTRIBUTING.md](CONTRIBUTING.md) for more information.
 
+## Releasing
+
+See [ReleaseProcess.md](doc/ReleaseProcess.md) for more information.
+
 ## History
 
 * 0.0.1 - Initial release, includes tests MD001-MD032.
diff --git a/doc/ReleaseProcess.md b/doc/ReleaseProcess.md
new file mode 100644
index 00000000..05c7b700
--- /dev/null
+++ b/doc/ReleaseProcess.md
@@ -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
diff --git a/test/markdownlint-test.js b/test/markdownlint-test.js
index 4d3d5843..6773218b 100644
--- a/test/markdownlint-test.js
+++ b/test/markdownlint-test.js
@@ -684,6 +684,7 @@ test("readmeHeadings", (t) => new Promise((resolve) => {
           "## Browser",
           "## Examples",
           "## Contributing",
+          "## Releasing",
           "## History"
         ]
       }