Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

CHANGELOG copyedits & pin 0.9.0 as next release & NPM script tweaks #1809

Merged
merged 2 commits into from
Feb 2, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
5 changes: 2 additions & 3 deletions .github/workflows/test.yaml
Original file line number Diff line number Diff line change
@@ -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

Expand All @@ -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
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
7 changes: 4 additions & 3 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,7 @@
"_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",
"build:preview": "npm run cd:docs build:preview",
"build:production": "npm run cd:docs build:production",
"build": "npm run cd:docs build",
Expand All @@ -22,15 +23,15 @@
"docs-install": "npm run _cd:docs -- npm install",
"fix:format": "npm run _check:format -- --write",
"get:hugo-modules": "node tools/getHugoModules/index.mjs",
"get:submodule": "set -x && git submodule update --init ${DEPTH:- --depth 1}",
"postinstall": "npm run _mkdir:hugo-mod",
"prebuild:preview": "npm run _prebuild",
"prebuild:production": "npm run _prebuild",
"prepare": "npm run _cp:bs-rfs",
"preserve": "npm run _prebuild",
"pretest": "npm run _prebuild",
"serve": "npm run cd:docs serve",
"test": "npm run cd:docs test && npm run check",
"test:all": "npm run _test:docs && npm run check",
"test": "npm run _test:docs",
"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