Set version number in documentation when publishing/announcing a new …

…release (pinterest#1581) * Set version number in documentation when publishing/announcing a new release * Update changelog Closes pinterest#1575
Goooler · Aug 15, 2022 · 93e97a3 · 93e97a3
1 parent 9162888
commit 93e97a3
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 3 deletions.
diff --git a/.announce b/.announce
@@ -31,7 +31,8 @@ escape_for_sed() { echo $1 | sed -e 's/[]\/$*.^|[]/\\&/g'; }
 
 # update readme.md
 
-sed -i "" "s/$(escape_for_sed $PREVIOUS_VERSION)/$(escape_for_sed $VERSION)/g" README.md
+sed -i "" "s/$(escape_for_sed $PREVIOUS_VERSION)/$(escape_for_sed $VERSION)/g" docs/install/cli.md
+sed -i "" "s/$(escape_for_sed $PREVIOUS_VERSION)/$(escape_for_sed $VERSION)/g" docs/install/integrations.md
 git --no-pager diff README.md
 
 # ask for user confirmation

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -162,6 +162,7 @@ Several methods for which it is unlikely that they are used by API consumers hav
 * Invoke callback on `format` function for all errors including errors that are autocorrected ([#1491](https://github.com/pinterest/ktlint/issues/1491))
 * Improve rule `annotation` ([#1574](https://github.com/pinterest/ktlint/pull/1574))
 * Rename `.editorconfig` property `disabled_rules` to `ktlint_disabled_rules` ([#701](https://github.com/pinterest/ktlint/issues/701))
+* Update release scripting to set version number in mkdocs documentation ([#1575](https://github.com/pinterest/ktlint/issue/1575)).
 
 ### Removed
 * Remove support to generate IntelliJ IDEA configuration files as this no longer fits the scope of the ktlint project ([#701](https://github.com/pinterest/ktlint/issues/701))

diff --git a/RELEASING.md b/RELEASING.md
@@ -18,6 +18,5 @@ signing.secretKeyRingFile=~/.gnupg/secring.gpg
 
 1. Update `VERSION_NAME` with new release version in project root `gradle.properties`
 2. Fill in `CHANGELOG.md` with related to new version changes.
-3. Run `./gradlew publishNewRelease` to build, upload new artifacts,
-update `README.md` and [https://ktlint.github.io](https://ktlint.github.io) site.
+3. Run `./gradlew publishNewRelease` to build, upload new artifacts, update KtLint version number on [CLI documentation](docs/install/cli.md) and [integrations documentation](docs/install/integrations.md) and [https://ktlint.github.io](https://ktlint.github.io) site.
 4. Update Github release notes with info from `CHANGELOG.md`