Rename the candidate file validator to forbidden files
This commit is contained in:
@@ -98,9 +98,9 @@ The `Candidate` supplies both `RepositoryDir` and `ModuleDir`, plus the declared
|
||||
module-local product checks. ReleaseKit calls `AdditionalChecks` once after
|
||||
shared validation when supplied.
|
||||
|
||||
For local token files, set `Validation.UntrackedFiles` to the repository-relative
|
||||
For local token files, set `Validation.ForbiddenFiles` to the repository-relative
|
||||
paths that should stay out of the committed candidate, such as
|
||||
`[]string{".releasekit/gitea-token"}`. Failures use `untracked-files` and carry the
|
||||
`[]string{".releasekit/gitea-token"}`. Failures use `forbidden-files` and carry the
|
||||
selected committed paths in `ValidationError.Findings`. This selection is
|
||||
independent of module and shared-file inputs; see [GoDoc](../../check.go) for
|
||||
the API contract and the [configuration reference](../config.md) for CLI use.
|
||||
|
||||
@@ -90,7 +90,7 @@ as `.releasekit/gitea-token` and configure:
|
||||
{
|
||||
"product": "Example",
|
||||
"validation": {
|
||||
"untracked_files": [".releasekit/gitea-token"]
|
||||
"forbidden_files": [".releasekit/gitea-token"]
|
||||
},
|
||||
"delivery": {
|
||||
"base_url": "https://gitea.example",
|
||||
|
||||
Reference in New Issue
Block a user