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

Any way to configure the package headings in the PR comments? #2045

Closed
dabeeeenster opened this issue Aug 15, 2023 · 1 comment
Closed

Any way to configure the package headings in the PR comments? #2045

dabeeeenster opened this issue Aug 15, 2023 · 1 comment
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

@dabeeeenster
Copy link

Is there any way to configure the package headings in the PR comments that Release Please generates?

As per Flagsmith/flagsmith#2628

image

We would like to include the package names - api|frontend|docs in the highlighted subheadings? Couldnt find anything in the docs for this.

Thanks!

@dabeeeenster dabeeeenster 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 Aug 15, 2023
@chingor13
Copy link
Contributor

Apologies for the late reply.

These headings should use component for the headings (also included in the tag). Some release-types can autodetect the component name (e.g. node looks at the name in package.json). If not, you can specify the component in the packages section:

{
  "release-type": "simple",
  "packages": {
    "path/to/api": {
      "component": "api"
    },
    "path/to/frontend": {
      "component": "frontend"
    }
  }
}

In the above example, we would create one PR with 2 sections (assuming both had releases pending). The titles would be something like api: 1.2.3 and frontend: 2.3.4 respectively and the releases tagged would be api-v1.2.3 and frontend-v2.3.4.

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

2 participants