Generalize changelog-draft

Open
#1 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

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

Research direction

Start in bin/changelog-draft at the linked sections around lines 72-78 and 92-103, and inspect how labels and sections are currently selected. Determine a configuration approach that works for repositories beyond mapbox-gl-js, then verify the generated changelog still sorts entries into the configured sections.

Written by the indexing model from the issue text.

Description

This quick-and-dirty sorting into sections is currently tied to mapbox-gl-js's labels/sections:

https://github.com/mapbox/github-release-tools/blob/8d88e10b6fedf3f34f8d3929287148088e65709c/bin/changelog-draft#L72-L78

https://github.com/mapbox/github-release-tools/blob/8d88e10b6fedf3f34f8d3929287148088e65709c/bin/changelog-draft#L92-L103

It should be made configurable so it can easily used for other repos

Dominant language
JavaScript
Stars
16
Forks
5
PR merge metrics
No merged PRs in 30d

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 mapbox/github-release-tools

All issues in mapbox/github-release-tools

Similar issues

More JavaScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.