Skip to content

Commit

Permalink
Changelog copyedits & pin 0.9.0 as next release & test script tweaks
Browse files Browse the repository at this point in the history
  • Loading branch information
chalin committed Feb 2, 2024
1 parent 435b2e0 commit e9ca8bd
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 12 deletions.
24 changes: 14 additions & 10 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,36 +11,38 @@ 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.

**New**:

**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]:
Expand Down Expand Up @@ -365,7 +367,9 @@ For the full list of changes, see the [0.2.0] release notes.

<!-- ENTRY TEMPLATE ------------------------------------------------------
## 0.X.Y - next planned release (unpublished yet)
## 0.X.Y
> ### UNRELEASED: this planned version is still under development.
For the full list of changes, see the [0.x.y] release notes.
Expand Down
6 changes: 4 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "docsy",
"version": "0.8.1-dev.0-unreleased",
"version": "0.9.0-dev.0-unreleased",
"repository": "github:google/docsy",
"homepage": "https://www.docsy.dev",
"license": "Apache-2.0",
Expand All @@ -10,6 +10,8 @@
"_cp:bs-rfs": "cp -R node_modules/bootstrap/scss/vendor/* assets/_vendor/bootstrap/scss/",
"_mkdir:hugo-mod": "npx mkdirp ../github.com/FortAwesome/Font-Awesome ../github.com/twbs/bootstrap",
"_prebuild": "npm run _cp:bs-rfs",
"_test:docs": "npm run cd:docs test",
"_test": "npm run _test:docs && npm run check",
"build:preview": "npm run cd:docs build:preview",
"build:production": "npm run cd:docs build:production",
"build": "npm run cd:docs build",
Expand All @@ -30,7 +32,7 @@
"preserve": "npm run _prebuild",
"pretest": "npm run _prebuild",
"serve": "npm run cd:docs serve",
"test": "npm run cd:docs test && npm run check",
"test": "npm run _test$DOCSY_TEST",
"update:pkg:dep": "npm install --save-exact @fortawesome/fontawesome-free@latest bootstrap@latest",
"update:pkg:hugo": "npm install --save-exact -D hugo-extended@latest"
},
Expand Down

0 comments on commit e9ca8bd

Please sign in to comment.