Skip to content
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

How to set changelog-types at root level? #2513

Open
WTPOptAxe opened this issue Mar 24, 2025 · 2 comments
Open

How to set changelog-types at root level? #2513

WTPOptAxe opened this issue Mar 24, 2025 · 2 comments
Assignees
Labels
priority: p3 Desirable enhancement or fix. May not be included in next release. type: question Request for information or clarification. Not an issue.

Comments

@WTPOptAxe
Copy link

We're using the release-please github application and want to configure changelog-types. https://github.com/googleapis/release-please-action states that this can be set at the root level, but I can't find any documentation on doing this without the action.

Is it possible to have changelog-types set once for all packages in release-please-config.json ?

Creating a config as below triggers a schema failure warning in github with the following message:

[
{
"instancePath": "",
"schemaPath": "#/additionalProperties",
"keyword": "additionalProperties",
"params": {
"additionalProperty": "changelog-types"
},
"message": "must NOT have additional properties"
}
]

config

{
  "changelog-types": [
    { "type": "feat", "section": "Features", "hidden": false },
    { "type": "fix", "section": "Bug Fixes", "hidden": false },
    { "type": "style", "section": "Styles", "hidden": false },
    {"type": "chore","section": "Miscellaneous Chores", "hidden": true,"bump": false},
    { "type": "refactor", "section": "Code Refactoring", "hidden": false },
    { "type": "ci", "section": "Continuous Integration", "hidden": false }
  ],
  "packages": {
    "src/app1": {
      "package-name": "app1",
      "changelog-path": "CHANGELOG.md"
    },
    "src/app2": {
      "package-name": "app2",
      "changelog-path": "CHANGELOG.md"
    } 
  },
  "release-type": "simple",
  "bump-minor-pre-major": true,
  "separate-pull-requests": true
}
@WTPOptAxe WTPOptAxe added priority: p3 Desirable enhancement or fix. May not be included in next release. type: question Request for information or clarification. Not an issue. labels Mar 24, 2025
@WIStudent
Copy link

changelog-types is the old property name, you need to use changelog-sections instead. The properties of the release-please-config.json are explained here https://github.com/googleapis/release-please/blob/main/docs/manifest-releaser.md#configfile

@WTPOptAxe
Copy link
Author

changelog-types is the old property name, you need to use changelog-sections instead. The properties of the release-please-config.json are explained here https://github.com/googleapis/release-please/blob/main/docs/manifest-releaser.md#configfile

Thanks - that's working better.

From what I'm reading there, I can't seem to include chore entries in the CHANGELOG unless I also trigger releases on chores. Is that correct?

If I use the following, chore's don't appear in the CHANGELOG when I do a feat or a fix. But if I change hidden to false, then any new commits with chore commits create a release.

{
      "type": "chore",
      "section": "Miscellaneous Chores",
      "hidden": true,
    },

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
priority: p3 Desirable enhancement or fix. May not be included in next release. type: question Request for information or clarification. Not an issue.
Projects
None yet
Development

No branches or pull requests

3 participants