Skip to content

Commit

Permalink
fix(docs): codegen docs before cutting a new version (#4183)
Browse files Browse the repository at this point in the history
# Description

## Problem\*

Resolves <!-- Link to GitHub Issue -->

## Summary\*

Currently when cutting a release in CI, docusaurus is looking for
`processed-docs` however this hasn't been generated.

This PR then ensures this is up to date when generating a release by
running `preprocess` before doing so.

## Additional Context



## Documentation\*

Check one:
- [x] No documentation needed.
- [ ] Documentation included in this PR.
- [ ] **[Exceptional Case]** Documentation to be submitted in a separate
PR.

# PR Checklist\*

- [x] I have tested the changes locally.
- [x] I have formatted the changes with [Prettier](https://prettier.io/)
and/or `cargo fmt` on default settings.
  • Loading branch information
TomAFrench authored Jan 29, 2024
1 parent 5e3c0f1 commit 2914310
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 2 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ jobs:
- name: Cut a new version
working-directory: ./docs
run: yarn docusaurus docs:version ${{ steps.noir-version.outputs.semver }}
run: yarn version ${{ steps.noir-version.outputs.semver }}

- name: Configure git
run: |
Expand Down
3 changes: 2 additions & 1 deletion docs/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,8 @@
"start": "yarn preprocess && docusaurus start",
"build": "yarn preprocess && yarn version::stables && docusaurus build",
"version::stables": "ts-node ./scripts/setStable.ts",
"serve": "serve build"
"serve": "serve build",
"version": "yarn preprocess && docusaurus docs:version"
},
"dependencies": {
"@docusaurus/core": "^3.0.1",
Expand Down

0 comments on commit 2914310

Please sign in to comment.