Skip to content

docs: specify hugo 150 #4664

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.

Sign up for GitHub

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

Merged
merged 4 commits into from
Sep 23, 2025
Merged

docs: specify hugo 150 #4664

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
64166f5
Update README.md
baileympearson Sep 18, 2025
982ff29
Update README.md
baileympearson Sep 18, 2025
b1869ee
enforce hugo version at runtime
baileympearson Sep 22, 2025
2ed702f
daria's comment
baileympearson Sep 22, 2025
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
6 changes: 4 additions & 2 deletions etc/docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@ necessary to backport a feature).

`build.ts` requires the following in addition to dependencies installed with `npm i`:

* Hugo static web generator `v0.30.2`
* You can download the right version [here](https://github.com/gohugoio/hugo/releases/tag/v0.30.2)
* Hugo static web generator `v0.150.0`
* You can download the right version [here](https://github.com/gohugoio/hugo/releases/tag/v0.150.0)
* ts-node

Note: `typedoc` is also a dependency but it is downloaded by the docs generation script automatically.
Expand All @@ -32,6 +32,8 @@ To generate API documentation for a new major or minor version:

`npm run build:docs -- --tag <version>`

`<version>` should be formatted MAJOR.MINOR (ex. `--tag=6.8`)

You can optionally specify the following options:

- `--yes` if set, this will silence any prompts in the script. useful for running in CI
Expand Down
4 changes: 3 additions & 1 deletion etc/docs/build.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,6 @@ async function updateSiteTemplateForNewVersion(

await writeFile(RELEASES_TOML_FILE, stringify(tomlData as any));
await writeFile(RELEASES_JSON_FILE, JSON.stringify(jsonVersions, null, 4));

// generate the site from the template
await exec(`hugo -s template -d ../temp -b "/node-mongodb-native"`);
}
Expand All @@ -80,6 +79,9 @@ async function main() {
process.exit(1);
}

const { stdout } = await exec('hugo version', { encoding: 'utf8' });
if (!stdout.includes('0.150.0')) throw new Error('`hugo` version must be 0.150.0.');

chdir(__dirname);

const { tag, status, skipPrompts } = getCommandLineArguments();
Expand Down