From 5d96fa33bf4b1dc4df0b8a34693ae4f6d2a9f283 Mon Sep 17 00:00:00 2001 From: Patrice Chalin Date: Fri, 2 Feb 2024 05:38:20 -0500 Subject: [PATCH] CHANGELOG copyedits & pin 0.9.0 as next release & NPM script tweaks (#1809) --- .github/workflows/test.yaml | 5 ++--- CHANGELOG.md | 24 ++++++++++++++---------- package.json | 7 ++++--- 3 files changed, 20 insertions(+), 16 deletions(-) diff --git a/.github/workflows/test.yaml b/.github/workflows/test.yaml index 589f1a51f9..7d09b7e0cc 100644 --- a/.github/workflows/test.yaml +++ b/.github/workflows/test.yaml @@ -1,5 +1,4 @@ -# Runs `npm test` to build Docsy & the User Guide and run all repo checks across -# OSs. +# Build Docsy & the User Guide and run all repo checks across OSs. name: test @@ -25,4 +24,4 @@ jobs: cache: npm cache-dependency-path: package.json - run: npm install --omit=optional - - run: npm test + - run: npm run test:all diff --git a/CHANGELOG.md b/CHANGELOG.md index 9e1a15358a..eb2b40cd4f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -11,28 +11,30 @@ notes][releases]. Useful links: - [Releases] & [tags]. Jump to the [latest] release. -- Milestones: [23Q4], [24Q1] +- [Milestones] -[23Q4]: https://github.com/google/docsy/milestone/9 [24Q1]: https://github.com/google/docsy/milestone/10 [latest]: https://github.com/google/docsy/releases/latest +[milestones]: https://github.com/google/docsy/milestones [releases]: https://github.com/google/docsy/releases [tags]: https://github.com/google/docsy/tags -## 0.8.1 or 0.9.0 - next planned release, WIP +## 0.9.0 -For the full list of changes, see the [0.x.y] release notes. +> ### UNRELEASED: this planned version is still under development. + +For the full list of changes, see the [0.9.0] release notes. **Breaking changes**: - [Repository Links] now work for [multi-language] sites ([#1744]). For any given page, repository links are now computed from a page's _resolved_ - `File` path, as resolved _through_ mount points, if any. That is, the path - used is the one that refers to the file's actual location on disk, not it's - logical path in Hugo's [union file system]. + `File` path — as resolved _through_ mount points, if any. That is, the + path used is the one that refers to the file's actual location on disk, not + it's logical path in Hugo's [union file system]. - This is a breaking change pages of sites that use mounts and + This is a breaking change for pages of sites that use mounts and [path_base_for_github_subdir]. Projects will need to adjust the value of [path_base_for_github_subdir] to be relative to the file's physical location. @@ -40,7 +42,7 @@ For the full list of changes, see the [0.x.y] release notes. **Other changes**: -[0.x.y]: https://github.com/google/docsy/releases/latest?FIXME=v0.X.Y +[0.9.0]: https://github.com/google/docsy/releases/latest?FIXME=v0.9.0 [#1744]: https://github.com/google/docsy/pull/1744 [multi-language]: https://www.docsy.dev/docs/language/ [path_base_for_github_subdir]: @@ -365,7 +367,9 @@ For the full list of changes, see the [0.2.0] release notes.