Skip to content
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
2 changes: 1 addition & 1 deletion .release-please-manifest.json
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
{
".": "2.0.0"
".": "2.1.0"
}
11 changes: 8 additions & 3 deletions AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -193,7 +193,11 @@ generated page already.

The site is versioned. `writerside.cfg` is generated for every language and
carries the version from `package.json`, so the header names the release it was
built from, and `buildprofiles.xml` points the switcher at `help-versions.json`
built from. That line ends with an `x-release-please-version` annotation and the
five files are listed as `extra-files` in `release-please-config.json`, because
`release-please` would otherwise bump the version and leave the configurations a
release behind — which fails `npm run docs:check` on `main` and takes the deploy
with it. `buildprofiles.xml` points the switcher at `help-versions.json`
at the site root. The deploy publishes each build twice — at the root as the
current version, and under `/<version>/` as an archive — keeping the zips in a
`docs-archive` branch, because Pages replaces everything it serves on every
Expand All @@ -211,8 +215,9 @@ after all five builds sit in one directory — that is when it can know which
pages exist in which language.

The languages, and every label around the prose, are declared in
`scripts/docs/languages.mjs`. Adding a language is a change to that file and a
new matrix entry in `.github/workflows/docs.yml`; the rest follows.
`scripts/docs/languages.mjs`. Adding a language is a change to that file, a new
matrix entry in `.github/workflows/docs.yml` and its `writerside.cfg` in the
`extra-files` of `release-please-config.json`; the rest follows.

## 7. Parity is not attributed

Expand Down
23 changes: 23 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,28 @@
# Changelog

## [2.1.0](https://github.com/MaksymStoianov/apps-script-utils/compare/apps-script-utils-v2.0.0...apps-script-utils-v2.1.0) (2026-09-23)


### Features

* **docs:** link the translations under the breadcrumbs, and say once at the end that AI wrote this ([f880ce8](https://github.com/MaksymStoianov/apps-script-utils/commit/f880ce8d80822a7913a1354fe7e1b2e226a6c3cf)), closes [#539](https://github.com/MaksymStoianov/apps-script-utils/issues/539)
* **docs:** link the translations under the breadcrumbs, and the AI notice before the footer ([e89a2e8](https://github.com/MaksymStoianov/apps-script-utils/commit/e89a2e8790882961fceab00cdeeffa9d41373ead))
* **docs:** link the translations under the breadcrumbs, and the AI notice before the footer ([2450cf7](https://github.com/MaksymStoianov/apps-script-utils/commit/2450cf7aa3e9f371f59edae7dffce7251b599533))


### Bug Fixes

* **docs:** declare the build settings per instance, and check they land ([f338835](https://github.com/MaksymStoianov/apps-script-utils/commit/f338835b8db2e5e121caebc076eced90bc86c2b9))
* **docs:** declare the build settings per instance, and check they land ([7407642](https://github.com/MaksymStoianov/apps-script-utils/commit/7407642b6b95424a96be57e1eef13655c5dc7bc1)), closes [#539](https://github.com/MaksymStoianov/apps-script-utils/issues/539)
* **docs:** keep the injections — the build profile really is inert ([d646f6b](https://github.com/MaksymStoianov/apps-script-utils/commit/d646f6b138d62cc755dac23bdd414b2798ab3a98)), closes [#539](https://github.com/MaksymStoianov/apps-script-utils/issues/539)
* **docs:** mount the header controls reliably, and put the notice in the article ([ab18695](https://github.com/MaksymStoianov/apps-script-utils/commit/ab1869569f042f188c95117df8a703b49cd9964f)), closes [#539](https://github.com/MaksymStoianov/apps-script-utils/issues/539)
* **docs:** put the build profile at the solution root ([6cd294a](https://github.com/MaksymStoianov/apps-script-utils/commit/6cd294a77581f8d7eefe59c102fa00acfbe8f71c)), closes [#539](https://github.com/MaksymStoianov/apps-script-utils/issues/539)
* **docs:** put the language and search controls in the header ([354a443](https://github.com/MaksymStoianov/apps-script-utils/commit/354a4436bf0cd6b8fecec452492989f78ee782aa))
* **docs:** put the language and search controls in the header ([6c69ee6](https://github.com/MaksymStoianov/apps-script-utils/commit/6c69ee6abfa0238ff4e265a13470dd0510a6e184))
* **docs:** put the language and search controls in the header ([d578dc9](https://github.com/MaksymStoianov/apps-script-utils/commit/d578dc95cd7e308d0ebd151263361438dc0eaf69)), closes [#539](https://github.com/MaksymStoianov/apps-script-utils/issues/539)
* **docs:** write the head, the switcher and the notice in after the build ([d281d6f](https://github.com/MaksymStoianov/apps-script-utils/commit/d281d6f14552c357b77824069f839bc8320c1941))
* **docs:** write the head, the switcher and the notice in after the build ([85b127e](https://github.com/MaksymStoianov/apps-script-utils/commit/85b127e65654f9472d0142bc92e0fce7cefd063c)), closes [#539](https://github.com/MaksymStoianov/apps-script-utils/issues/539)

## [2.0.0](https://github.com/MaksymStoianov/apps-script-utils/compare/apps-script-utils-v1.10.0...apps-script-utils-v2.0.0) (2026-09-23)


Expand Down
2 changes: 1 addition & 1 deletion docs/writerside-de/writerside.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,5 @@
<topics dir="topics" web-path="topics"/>
<images dir="images" web-path="images"/>
<snippets src="snippets"/>
<instance src="asu.tree" version="2.0.0"/>
<instance src="asu.tree" version="2.1.0"/> <!-- x-release-please-version -->
</ihp>
2 changes: 1 addition & 1 deletion docs/writerside-fr/writerside.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,5 @@
<topics dir="topics" web-path="topics"/>
<images dir="images" web-path="images"/>
<snippets src="snippets"/>
<instance src="asu.tree" version="2.0.0"/>
<instance src="asu.tree" version="2.1.0"/> <!-- x-release-please-version -->
</ihp>
2 changes: 1 addition & 1 deletion docs/writerside-ru/writerside.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,5 @@
<topics dir="topics" web-path="topics"/>
<images dir="images" web-path="images"/>
<snippets src="snippets"/>
<instance src="asu.tree" version="2.0.0"/>
<instance src="asu.tree" version="2.1.0"/> <!-- x-release-please-version -->
</ihp>
2 changes: 1 addition & 1 deletion docs/writerside-uk/writerside.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,5 @@
<topics dir="topics" web-path="topics"/>
<images dir="images" web-path="images"/>
<snippets src="snippets"/>
<instance src="asu.tree" version="2.0.0"/>
<instance src="asu.tree" version="2.1.0"/> <!-- x-release-please-version -->
</ihp>
2 changes: 1 addition & 1 deletion docs/writerside/writerside.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,5 @@
<topics dir="topics" web-path="topics"/>
<images dir="images" web-path="images"/>
<snippets src="snippets"/>
<instance src="asu.tree" version="2.0.0"/>
<instance src="asu.tree" version="2.1.0"/> <!-- x-release-please-version -->
</ihp>
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "apps-script-utils",
"version": "2.0.0",
"version": "2.1.0",
"description": "Utilities for Google Apps Script™ projects.",
"main": "dist/index.js",
"types": "dist/index.d.ts",
Expand Down
9 changes: 8 additions & 1 deletion release-please-config.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,14 @@
".": {
"release-type": "node",
"package-name": "apps-script-utils",
"changelog-path": "CHANGELOG.md"
"changelog-path": "CHANGELOG.md",
"extra-files": [
"docs/writerside/writerside.cfg",
"docs/writerside-ru/writerside.cfg",
"docs/writerside-uk/writerside.cfg",
"docs/writerside-de/writerside.cfg",
"docs/writerside-fr/writerside.cfg"
]
}
}
}
10 changes: 9 additions & 1 deletion scripts/docs/site.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,14 @@ function widget(language) {
const ARTWORK =
"https://darynamikhailenko.com/?utm_source=docs&amp;utm_medium=footer&amp;utm_campaign=apps-script-utils&amp;utm_content=banner-artist-credit";

/**
* The version on the instance line carries the `x-release-please-version`
* annotation, because `release-please` bumps `package.json` without knowing
* that five generated files repeat the version it writes. The annotation is
* what its generic updater looks for, so the release pull request rewrites
* these configurations along with the version, and the check that compares the
* generated files to the sources still passes once the release lands.
*/
export function writersideCfg(version) {
return `<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE ihp SYSTEM "https://resources.jetbrains.com/writerside/1.0/ihp.dtd">
Expand All @@ -42,7 +50,7 @@ export function writersideCfg(version) {
<topics dir="topics" web-path="topics"/>
<images dir="images" web-path="images"/>
<snippets src="snippets"/>
<instance src="asu.tree" version="${version}"/>
<instance src="asu.tree" version="${version}"/> <!-- x-release-please-version -->
</ihp>
`;
}
Expand Down
Loading