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

Release 0.9.0 preparation #1860

Merged
merged 1 commit into from
Feb 14, 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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 0 additions & 3 deletions .markdown-link-check.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,6 @@
},
{
"pattern": "https://docs.npmjs.com/cli/v10/using-npm/scripts#prepare-and-prepublish"
},
{
"pattern": "https://www.docsy.dev/blog/2024/0.9.0/"
}
],
"timeout": "3s",
Expand Down
2 changes: 0 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,6 @@ Useful links:

## 0.9.0

> ### UNRELEASED: this planned version is still under development
For an introduction and commentary, see the [0.9.0 release report]. For the full
list of commits, see the [0.9.0] release notes. The most significant changes of
this release are listed next.
Expand Down
20 changes: 11 additions & 9 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,19 +57,21 @@ repo.
dependencies.
5. **Submit a PR with your changes**, using a title like "Release v0.X.Y
preparation".
6. **Get PR approved and merged**.
7. **Pull in `main`** to get the last PR.
8. **Ensure** that you're:
6. **Test the PR** branch from selected sites, and push any required
adjustments.
7. **Get PR approved and merged**.
8. **Pull in `main`** to get the last PR.
9. **Ensure** that you're:
- On the default branch, `main`
- At the commit that you want to tag as v0.X.Y
9. **Create tags** for v0.X.Y:
10. **Create tags** for v0.X.Y:

```sh
REL=v0.X.Y
git tag $REL
```

10. **Push the new tags** to the main repo, which is named `upstream` in the
11. **Push the new tags** to the main repo, which is named `upstream` in the
following example:

```console
Expand All @@ -78,7 +80,7 @@ repo.
* [new tag] v0.X.Y -> v0.X.Y
```

11. **[Draft a new release][]** using GitHub web; fill in the fields as follows:
12. **[Draft a new release][]** using GitHub web; fill in the fields as follows:

- From the **release/tag dropdown**: Select the new release tag that you
just pushed, v0.X.Y.
Expand All @@ -96,9 +98,9 @@ repo.

- Select **Create a discussion for this release**.

12. **Publish the release**: click _Publish release_.
13. Test the release with a downstream project, such as [docsy-example].
14. If you find issues, determine whether they need to be fixed immediately. If
13. **Publish the release**: click _Publish release_.
14. Test the release with a downstream project, such as [docsy-example].
15. If you find issues, determine whether they need to be fixed immediately. If
so, get fixes submitted, reviewed and approved. Then publish a dot release:
go back to step 1.

Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "docsy",
"version": "0.9.0-dev.0-unreleased",
"version": "0.9.0",
"repository": "github:google/docsy",
"homepage": "https://www.docsy.dev",
"license": "Apache-2.0",
Expand Down
4 changes: 2 additions & 2 deletions userguide/content/en/blog/2024/0.9.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,8 +95,8 @@ that the necessary [functions] became available. For details, see:

We're convinced that Lisa's fix has squashed repo-link bugs for good!

As mentioned in the [CHANGELOG][0.9.0], this is a **breaking change** for sites
that use mounts and that have pages configured with
As mentioned in the [CHANGELOG][CL@0.9.0], this is a **breaking change** for
sites that use mounts and that have pages configured with
[path_base_for_github_subdir].

As can be seen from [Repository / page-meta link fixes and improvements
Expand Down
2 changes: 1 addition & 1 deletion userguide/hugo.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ params:
privacy_policy: https://policies.google.com/privacy
version_menu: Releases
archived_version: false
version: 0.8.0
version: 0.9.0
url_latest_version: https://example.com
github_repo: https://github.com/google/docsy
github_project_repo: https://github.com/google/docsy
Expand Down