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

proposal: allow of a more flexibel way of adding more information to parsed commit messages

Open
#338 0 comments 5 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

The release-notes-generator is responsible of parsing commit messages into an object and writing release notes.

There is currently no easy way of adding custom code to enhance the parsed commit message. Like adding more information/references.

The use case I have is that we need to link service desk tickets as references to the commit. This is based on the our internal JIRA ticket number. The internal ticket number is correctly parsed. What I now want to do is parse the JIRA ticket number, call the JIRA API and check for linked service desk tickets and add them as reference.

Currently there is no way of doing this without creating a completely custom module. I believe it would be useful if there would be an extra step between parsing and writing where custom plugins/modules can perform transformation on the commit objects. Each plugin can then do there own custom thing.

What do you think?

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 by tracing how the release-notes-generator parses commit messages into objects and then writes release notes. Identify the boundary where a plugin or custom module could transform parsed commits, including adding references from external ticket data. Done means custom transformations can be configured without creating a completely custom module.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
release
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.