Skip to content

fix(schema): add missing config properties accepted by code#2765

Open
chad-loder wants to merge 1 commit into
googleapis:mainfrom
chad-loder:fix/sync-config-schema
Open

fix(schema): add missing config properties accepted by code#2765
chad-loder wants to merge 1 commit into
googleapis:mainfrom
chad-loder:fix/sync-config-schema

Conversation

@chad-loder
Copy link
Copy Markdown

Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:

  • Make sure to open an issue as a bug/issue before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea
  • Ensure the tests and linter pass
  • Code coverage does not decrease (if any source code was changed)
  • Appropriate docs were updated (if necessary)

Fixes #2518 🦕


The config JSON schema (schemas/config.json) is missing several
properties that the TypeScript types in src/manifest.ts accept at
runtime. This causes false-positive validation errors for users who
validate their config against the published schema.

Added properties

Property Type TypeScript source
include-commit-authors boolean ReleaserConfigJson L183
component string ReleaserPackageConfig L227
package-name string ReleaserPackageConfig L226
skip-snapshot boolean ReleaserConfigJson L193

All four are added to the ReleaserConfigOptions definition and to
the top-level properties allowlist. Purely additive — no existing
properties are modified, narrowed, or removed.

Repro (before this fix)

cat > /tmp/rp-test.json <<'JSON'
{
  "release-type": "python",
  "include-commit-authors": true,
  "packages": { ".": { "package-name": "my-pkg" } }
}
JSON

npx check-jsonschema \
  --schemafile https://raw.githubusercontent.com/googleapis/release-please/main/schemas/config.json \
  /tmp/rp-test.json
# => Additional properties are not allowed ('include-commit-authors' was unexpected)

@chad-loder chad-loder requested review from a team as code owners April 25, 2026 23:17
@product-auto-label product-auto-label Bot added the size: s Pull request size is small. label Apr 25, 2026
The config JSON schema is missing several properties that
`ReleaserConfigJson` and `ReleaserPackageConfig` accept at runtime:

- `include-commit-authors` (boolean) — changelog author attribution
- `component` (string) — per-package component name
- `package-name` (string) — per-package distribution name
- `skip-snapshot` (boolean, Java-only) — suppress snapshot PRs

Adds all four to `ReleaserConfigOptions` (shared definition) and to
the top-level `properties` allowlist. Purely additive — no existing
properties are modified, narrowed, or removed.

Fixes googleapis#2518
@chad-loder chad-loder force-pushed the fix/sync-config-schema branch from 185b61a to 56f8fdb Compare April 26, 2026 00:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size: s Pull request size is small.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Config json schema is out-of-date

2 participants