PB-2045 Enable formatter for Release Notes #95
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Typically, this is what happens: 1. We manually run the formatter (`npm run format`). This adds whitespace to `releases-sidebar.json`. 2. In Codebuild, we first run the build with `npm run docs:build`. This removes the whitespace added by the formatter again. 3. Codebuild checks the format with `npm run format:check` and complains. See [the CodeBuild build specs for a PR in doc-tech](https://github.com/geoadmin/infra-terraform-bgdi/blob/master/tf/aws/swisstopo-bgdi-builder/codebuild_projects/doc-tech/buildspec_pr.yml). By having the formatter ignore `release-sidebar.json` we avoid the problem.
pedroslvieira
approved these changes
Nov 27, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Typically, this is what happens:
npm run format). This adds whitespace toreleases-sidebar.json.npm run docs:build. This removes the whitespace added by the formatter again.npm run format:checkand complains.See the CodeBuild build specs for a PR in doc-tech.
By having the formatter ignore
release-sidebar.jsonwe avoid the problem.Test link