Schema rejects valid root-level prerelease-type option

Open Beginner friendly
#2,814 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
82/100
Issue type
Bug
Clarity
Clearly specified
Activity status
Quiet
Tech stack
json, typescript
Domain
developer-experience, tooling

Research direction

Start with schemas/config.json and inspect how ReleaserConfigOptions is included at the root through allOf. Validate a root-level "prerelease-type": "alpha" configuration before and after the change; done means the schema accepts the option at the root while preserving its existing package validation.

Written by the indexing model from the issue text.

Description

priority: p2 type: bug

schemas/config.json rejects a prerelease-type set at the root of the manifest config, even though it is a valid root option (it is defined in ReleaserConfigOptions and applied at the root via allOf, where it acts as the default for all packages).

Environment details
  • OS: any
  • Node.js version: n/a (schema validation in editor)
  • npm version: n/a
  • release-please version: schema on main
Steps to reproduce
  1. Add "prerelease-type": "alpha" at the root of a release-please-config.json that references schemas/config.json via $schema.
  2. Validate against the schema (e.g. in an editor with JSON schema support).
  3. Validation fails with Property prerelease-type is not allowed.

The option works at runtime; only schema validation is affected.

Dominant language
TypeScript
Stars
7.5k
Forks
589
Avg merge
14h 14m
Merged PRs (30d)
6

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from googleapis/release-please

All issues in googleapis/release-please

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.