dash0hq/Sync docs to the Dash0 website
Transform documentation files from a source repository according to its transformations.yaml and open (or update) a pull request in the Dash0 documentation repository.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| source-root | Path (relative to the caller's workspace) to the root of the source repository — the directory that contains the documentation files referenced from the transformations file. | no | . |
| transformations-file | Path (relative to source-root) to the transformations.yaml file describing the sync. | no | .github/workflows/sync-docs/transformations.yaml |
| dry-run | When "true", stop after applying the transformations (including the coverage check, when the transformations file declares one): the target repository is not checked out, nothing is copied, and no commit or pull request is created. Use this to detect docs drift early on non-release builds. Dry runs need none of the target-side inputs, so they also work in contexts where no token is available. | no | false |
| target-repository | The owner/name of the documentation repository the sync writes into. Callers should supply this from a repository secret or variable rather than hardcoding it in a public workflow file. Required unless dry-run is "true". | no | "" |
| target-directory | Path (relative to the target repository root) that receives the transformed files. This is where the transformations' `target` paths are resolved from. Callers should supply this from a repository secret or variable rather than hardcoding it in a public workflow file. Required unless dry-run is "true". | no | "" |
| target-github-token | Token used to push the sync branch and open the pull request in the target repository. Must have `contents:write` and `pull-requests:write` on the target repository. Required unless dry-run is "true". | no | "" |
| target-base-branch | Branch in the target repository the pull request is opened against. | no | main |
| pr-branch | Branch name used for the sync pull request in the target repository. Required unless dry-run is "true". | no | "" |
| pr-title | Title of the pull request opened against the target repository. Required unless dry-run is "true". | no | "" |
| pr-body | Body of the pull request opened against the target repository. Required unless dry-run is "true". | no | "" |
| pr-reviewers | Comma-separated GitHub handles (users or org/team slugs) requested as reviewers on a newly opened pull request. Ignored when an open pull request for pr-branch already exists. | no | "" |
| pr-assignees | Comma-separated GitHub handles assigned to a newly opened pull request. Ignored when an open pull request for pr-branch already exists. | no | "" |
| commit-message | Commit message used when the sync produces changes. | no | "" |
Outputs
no outputs