Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Allow opting-out of username links in release notes #1248

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

lilnasy
Copy link

@lilnasy lilnasy commented Oct 19, 2023

This PR adds a config to @changesets/changelog-github to remove links from GitHub usernames, allowing contributors to appear prominently in releases in the "Contributors" section.

To make use of this feature, set linkUsernames to false in your .changeset/config.json file:

{
    "$schema": "https://unpkg.com/@changesets/config@1.7.0/schema.json",
    "changelog": [
        "@changesets/changelog-github",
        {
            "repo": "your-org/your-repo",
+           "linkUsernames": false
        }
    ]
}

See GitHub documentation for more details.

@changeset-bot
Copy link

changeset-bot bot commented Oct 19, 2023

🦋 Changeset detected

Latest commit: ec71a9a

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@changesets/changelog-github Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@codesandbox-ci
Copy link

codesandbox-ci bot commented Oct 19, 2023

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

Latest deployment of this branch, based on commit ec71a9a:

Sandbox Source
Vanilla Configuration

@Andarist
Copy link
Member

I just wonder if we shouldn't transform the release notes and unlinkify those there. The downside of the proposed approach here is that the generated markdown won't have those links in it. GitHub doesn't automatically linkify those mentions in markdown files

@lilnasy
Copy link
Author

lilnasy commented Oct 24, 2023

I was under the impression that the getReleaseLine function would only be ised for releases not changelog. I agree CHANGELOG.md does not need to change. I will look into your suggestion.

@Andarist
Copy link
Member

Those are called to generate the CHANGELOG entries and the latest update is extracted by this function. So to do what I suggested you'd have to transform the extracted content there

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants