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

Pack our own conventional-changelog preset package?

Open
#1,028 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

Hey @semantic-release/maintainers,

What do you think about switching from this practice to shipping our own npm package for supported presets, considering the conventional-changelog dropping all other preset to supporting just 2 (i.e. angular and conventionalcommits), this should fairly be package.

This way we can ship with conventional-changelog-angular and conventional-changelog-conventionalcommits as deps allowing users to just set any of both as their preset without needing to install any preset package. this also helps us avoid scenarios like https://github.com/conventional-changelog/conventional-changelog/issues/1495 in the future where user installs preset that's incompatible with our conventional-changelog-writer.

🤔

Originally posted by @babblebey in https://github.com/semantic-release/release-notes-generator/pull/1026#discussion_r3834241568

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 reviewing the repository's current preset handling and the discussion in pull request #1026. Compare the proposed package dependencies, conventional-changelog-angular and conventional-changelog-conventionalcommits, with the current user setup. Done means an agreed package design that supports both preset names without requiring users to install separate preset packages.

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
Active
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.