Skip to content

Commit 24e96f1

Browse files
authored
Release 0.14.2 preparation (#2551)
1 parent 8cb163d commit 24e96f1

File tree

6 files changed

+56
-28
lines changed

6 files changed

+56
-28
lines changed

docsy.dev/content/en/blog/2026/0.14.0.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -68,8 +68,8 @@ cSpell:ignore: docsy subrepo lightdark lookandfeel onedark
6868
processing
6969
- {{% _param BREAKING %}}
7070
[Hugo 0.155.0 requirement and 0.153+ breaking changes](#hugo)
71-
- {{% _param BREAKING %}} [Docsy 0.14.2 code-style update](#0.14.2) for
72-
light/dark mode
71+
- {{% _param BREAKING %}} (style-only)
72+
[Docsy 0.14.2 code-style update](#0.14.2) for light/dark mode
7373
- Optionally skim:
7474
- {{% _param NEW %}} New features (look for the green checkmark icon)
7575
- {{% _param CLEANUP %}} Cleanup / improvement opportunities (look for this

docsy.dev/content/en/docs/contributing.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,10 @@ make Docsy and its docs even better.
1313
>
1414
> We welcome your contributions but note that:
1515
>
16-
> - We cannot guarantee when pull requests will be reviewed.
16+
> - We cannot guarantee _when_ your [pull requests][pr] (PRs) will be reviewed.
1717
> - Review does not guarantee acceptance or merging.
18-
> - We may reject pull requests with content (e.g., AI-generated) that does not
19-
> meet our quality standards.
18+
> - We may reject PRs with content (e.g., AI-generated) that does not meet our
19+
> quality standards.
2020
2121
> [!NB] Maintainers, see [Maintainer notes](/project/about/contributing/).
2222
@@ -75,7 +75,7 @@ familiar with basic GitHub workflows.
7575

7676
1. Fork the [Docsy repo](https://github.com/google/docsy) on GitHub: this site's
7777
files live in the `docsy.dev` subdirectory.
78-
1. Make your changes and send a pull request (PR).
78+
1. Make your changes and send a [pull request][pr] (PR).
7979
1. If you're not yet ready for a review, add "WIP" to the PR name to indicate
8080
it's a work in progress. (**Don't** add the Hugo property "draft = true" to
8181
the page front matter, because that prevents the auto-deployment of the
@@ -210,3 +210,6 @@ fix it yourself, please create an issue in
210210
[this repository](https://github.com/google/docsy). You can also create an issue
211211
about a specific page by clicking the **Create Issue** button in the top right
212212
hand corner of the page.
213+
214+
[PR]:
215+
https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request

docsy.dev/content/en/project/about/changelog.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -150,7 +150,7 @@ For the full list of changes, see the [0.15.0][] release page.
150150
For the full list of changes, see the [release report][0.14.2-blog] and
151151
[0.14.2][] release page.
152152

153-
[**Breaking changes**](#breaking-change):
153+
[**Breaking changes**](#breaking-change) (style-only):
154154

155155
- **[Default code styles][0.14.2-blog]** changed from `tango`/`onedark` to
156156
`friendly`/`native` for sites using `td/code-dark` ([#2548]).

docsy.dev/content/en/project/about/maintainer-notes.md

Lines changed: 43 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -19,43 +19,68 @@ accordingly.
1919
2. **Create or update a [changelog][] entry** for {{% param version %}}.
2020
- The section should provide a brief summary of breaking changes using the
2121
section template at the end of the file.
22-
- Ensure to remove the UNRELEASED note.
22+
- Ensure to remove the UNRELEASED note, if still present.
2323
- You'll create a new section for the next release in a later step.
2424

2525
3. **Update the release report blog post** for {{% param version %}}, if any.
2626
- Remove draft status.
27-
- Update the date to today's date.
27+
- Set `date` (or `lastmod` if already published) to today's date.
2828

2929
4. Run `npm run fix`.
3030

31-
> Note: This might update the version in `package.json` via `fix:version`,
31+
> [!NOTE]
32+
>
33+
> This command might update the version in `package.json` via `fix:version`,
3234
> but you can ignore this change since you'll be setting the version
3335
> explicitly in the next step.
3436
3537
5. **Update Docsy version** to {{% param version %}} using the following from a
36-
(bash or zsh) terminal:
38+
(bash or zsh) terminal.
39+
- First set the `VERSION` variable; we use it throughout the steps below.
3740

38-
```sh
39-
VERSION={{% param version %}}
40-
npm run set:version -- --version $VERSION
41-
```
41+
```sh
42+
VERSION={{% param version %}}
43+
```
44+
45+
- Then run the `set:version` script.
4246

43-
This updates both `version` keys in [package.json] and
44-
[docsy.dev/hugo.yaml]. You can omit the argument to `--version` when the
45-
package is already a dev version of {{% param version %}}.
47+
Docsy is probably already at `{{% param version %}}-dev`, so you can run:
48+
49+
```sh
50+
npm run set:version
51+
```
52+
53+
Otherwise, set the version explicitly:
54+
55+
```sh
56+
npm run set:version -- --version $VERSION
57+
```
58+
59+
Both forms update the `version` related fields in [package.json][] and
60+
[docsy.dev/hugo.yaml][].
4661

4762
6. <a id="ci-test-step">Run `npm run ci:test`</a>, which runs `ci:prepare` and
4863
more to ensure that, e.g., vendor assets and [go.mod] dependencies are
4964
up-to-date, etc.
5065

51-
7. **Submit a PR with your changes**, using a title like "Release
52-
{{% param version %}} preparation". Use this command to create the PR via
53-
the web interface:
66+
7. **Submit a PR with your changes**.
67+
- Commit any changes accumulated from the previous steps using this title:
5468

55-
```sh
56-
gh pr create --web --title "Release $VERSION preparation" \
57-
--body "- Contributes to #<ADD-RELEASE-PREP-ISSUE-HERE>"
58-
```
69+
```text
70+
Release {{% param version %}} preparation
71+
```
72+
73+
- Create a PR (with version-checks disabled) using the following command
74+
that will open a PR-creation page in your browser:
75+
76+
```sh
77+
export SKIP_VERSION_CHECK=1
78+
gh pr create --web --title "Release $VERSION preparation" \
79+
--body "- Contributes to #<ADD-RELEASE-PREP-ISSUE-HERE>"
80+
```
81+
82+
- Use the web interface to fill in the PR details.
83+
- Submit the PR.
5984

6085
8. **Test the PR** branch from selected sites, and push any required
6186
adjustments.

docsy.dev/hugo.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,8 +62,8 @@ params:
6262
to_year: present
6363
privacy_policy: https://policies.google.com/privacy
6464
archived_version: false
65-
version: 0.14.2-dev
66-
versionWithBuildId: 0.14.2-dev+007-over-main-a1ddcab5
65+
version: 0.14.2
66+
versionWithBuildId: 0.14.2
6767
github_repo: https://github.com/google/docsy
6868
github_project_repo: https://github.com/google/docsy
6969
github_subdir: docsy.dev

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "docsy",
3-
"version": "0.14.2-dev+007-over-main-a1ddcab5",
3+
"version": "0.14.2",
44
"repository": "github:google/docsy",
55
"homepage": "https://www.docsy.dev",
66
"license": "Apache-2.0",

0 commit comments

Comments
 (0)