Repository navigation
fix(techdocs): accept only plain version strings and a relative build directory #181
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
Merged
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -23,6 +23,30 @@ | |
| `push:` trigger of the caller list that branch. | ||
| - Delegates to `reusable-backstage-techdocs.yml@v1` with safe defaults for AWS | ||
| region, environment, and tool versions. | ||
| - The reusable workflow accepts only plain version strings for the tools it | ||
| installs, because they are installed in the job that holds the publisher's | ||
| AWS role. It stops with an error, before the checkout, if a value (input or | ||
| the matching variable) does not match: | ||
|
coderabbitai[bot] marked this conversation as resolved.
Resolved
|
||
|
|
||
| | Input (variable) | Default | Accepted | | ||
| | --- | --- | --- | | ||
| | `techdocs_cli_version` (`TECHDOCS_CLI_VERSION`) | `latest` | a semver version or range (`1.9.0`, `^1.9.0`, `~1.9`, `1.x`, `>=1.9.0 <2.0.0`) or a dist-tag (`latest`, `next`) | | ||
| | `mkdocs_core_version` (`MKDOCS_TECHDOCS_CORE_VERSION`) | `>=1.6,<2.0` | comma-separated pip version specifiers (`>=1.6,<2.0`, `==1.6.1`, `~=1.6`) | | ||
| | `node_version` (`TECHDOCS_NODE_VERSION`) | `24` | a Node.js version (`24`, `24.1.0`, `24.x`, `lts/*`) | | ||
| | `python_version` (`TECHDOCS_PYTHON_VERSION`) | `3.13` | a Python version (`3.13`, `3.13.1`, `3.x`, `pypy3.10`) | | ||
| | `build_directory` (`TECHDOCS_BUILD_DIR`) | `site` | a relative directory inside the checkout (`site`, `./site`, `build/site/`), no `..` and no leading `/` | | ||
|
|
||
| Git, URL, file and alias specs (`github:owner/repo`, `npm:other@1`, | ||
| `file:...`, ` @ https://...`), pip extras and markers are refused. Docs are | ||
| generated into `build_directory`. The workflow also stops, before | ||
| generation and again before publishing, if any symlink in the checkout | ||
| (a docs page, the build directory, or a link inside a symlinked directory) | ||
| leads outside the checkout. | ||
|
|
||
| These checks are in the reusable workflow, so a caller gets them only from a | ||
| pin that includes them. Callers pinned to `@v1` get them with the release; | ||
| callers pinned to a commit SHA of an earlier version (v1.43.5 or older) must | ||
| update the pin. New repositories get the current pin from the template. | ||
| - Uses `TECHDOCS_AWS_ACCOUNT_ID` of `geolonia/.github` repository secret by default; | ||
| optional inputs allow setting a repo secret `AWS_ACCOUNT_ID` to override on a | ||
| per-repo basis. | ||
|
4677
|
||
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.