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

question: link to both GH PR numbers and external issues

Open
#391 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

I have the following config

  - path: '@semantic-release/release-notes-generator'
    preset: conventionalcommits
    presetConfig:
      issuePrefixes:
        - 'FOO-'
        - 'BAR-'
      issueUrlFormat: 'https://linear.app/xyz/issue/{{prefix}}{{id}}'

which works great. However, that means that where before I'd have the changelog link for the GH PR #

* do something (FOO-775) ([#779](https://github.com/xyz/somerepo/issues/779)) ([f885465](https://github.com/xyz/somerepo/commit/f88546534c2d6650674e522bd2e0d3aeca26586a))

Now I have the link to the issue within our issue tracking system (Linear, in this case), and the commit, but not to the PR #:

* do something ([FOO-775](https://linear.app/xyz/issue/FOO-775)) (#779) ([f885465](https://github.com/xyz/somerepo/commit/f88546534c2d6650674e522bd2e0d3aeca26586a))

Is there a way to keep issue / PR #s from GH working while also linking to our issues as well (for example, can I have two different configs for the issue prefixes / url format)?

Also, is there an easy way to regenerate / backfill existing items after changing the config?

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

No files, tests, or entry points are named. Start by tracing how issuePrefixes and issueUrlFormat are read and how changelog links are rendered; determine the expected behavior for simultaneous GitHub PR and external issue links and for backfilling existing entries, then capture those cases in tests.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.