Skip to content

Release Drafter: Automatically replace GitHub handles with real names and links #2775

@seisman

Description

@seisman

Currently, the Release Drafter shows the contributors as a comma-separated list of GitHub handles, e.g., https://github.com/GenericMappingTools/pygmt/releases:

image

When we make a release, we prefer to have a bulleted list with contributors' real names and links, like:

image

So we have to make the conversions manually which is tedious.

The Release Drafter provides the replacers option, which can search and replace content in the generated changelog body. I think we can use this option to automatically replace GitHun handles with real names and links. This can be done by adding something like below to the .github/release-drafter.yml file:

replacers:
  - search: '@seisman'
    replace: '[Dongdong Tian](https://github.com/seisman)'

Metadata

Metadata

Assignees

No one assigned

    Labels

    maintenanceBoring but important stuff for the core devs

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions