semantic-release / semantic-release/release-notes-generator

Question: conventionalcommits preset with PR owner

Open
#393 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
368
Forks
55
Avg merge
10m
Merged PRs (30d)
1

Description

We have conventionalcommits preset in out pipeline that generates the following changelog.

image

Here's the full set of config.

[
      // produces the release notes that are consumed by the changelog
      // plugin and by the GitHub plugin (for GitHub releases)
      '@semantic-release/release-notes-generator',
      {
        preset: 'conventionalcommits',
        presetConfig: {
          types,
        },
        writerOpts: {
          commitGroupsSort: (a, b) => {
            const commitGroupOrder = [
              nameForType('revert'),
              nameForType('perf'),
              nameForType('fix'),
              nameForType('feat'),
            ];
            const gRankA = commitGroupOrder.indexOf(a.title);
            const gRankB = commitGroupOrder.indexOf(b.title);
            if (gRankA >= gRankB) {
              return -1;
            }
            return 1;
          },
        },
      },
    ]

Is there a way to change that to append the PR owner to each row of commit message?

Contributor guide

No contributing guide indexed for this repository

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.

Research direction

Start with the release-notes-generator configuration shown in the issue, especially the conventionalcommits preset and writerOpts entry point. Check the preset and writer configuration documentation to determine whether pull-request owner data is available to the renderer; done means each generated commit row includes the owner without breaking the existing changelog output.

Written by the indexing model from the issue text.

Assessment

Tech stack
github, javascript
Domain
release
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.