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

ReleaseTooling: Exclude links to contributors' user profiles from changelog #26257

Merged
merged 2 commits into from
Mar 6, 2024

Conversation

vanessayuenn
Copy link
Contributor

@vanessayuenn vanessayuenn commented Feb 29, 2024

What I did

This PR removes the explicit links to user profiles in generated changelogs.

It seems like GitHub releases now recognize GitHub handles in the changelog as contributors, and so we don't have to explicitly link to contributors' profiles anymore. In fact, doing so will cause GitHub to not recognize them properly and exclude them from the Contributors section (example).

Checklist for Contributors

Testing

The changes in this PR are covered in the following automated tests:

  • stories
  • unit tests
  • integration tests
  • end-to-end tests

Manual testing

This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!

Documentation

  • Add or update documentation reflecting your changes
  • If you are deprecating/removing a feature, make sure to update
    MIGRATION.MD

Checklist for Maintainers

  • When this PR is ready for testing, make sure to add ci:normal, ci:merged or ci:daily GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found in code/lib/cli/src/sandbox-templates.ts

  • Make sure this PR contains one of the labels below:

    Available labels
    • bug: Internal changes that fixes incorrect behavior.
    • maintenance: User-facing maintenance tasks.
    • dependencies: Upgrading (sometimes downgrading) dependencies.
    • build: Internal-facing build tooling & test updates. Will not show up in release changelog.
    • cleanup: Minor cleanup style change. Will not show up in release changelog.
    • documentation: Documentation only changes. Will not show up in release changelog.
    • feature request: Introducing a new feature.
    • BREAKING CHANGE: Changes that break compatibility in some way with current major version.
    • other: Changes that don't fit in the above categories.

🦋 Canary release

This PR does not have a canary release associated. You can request a canary release of this pull request by mentioning the @storybookjs/core team here.

core team members can create a canary release here or locally with gh workflow run --repo storybookjs/storybook canary-release-pr.yml --field pr=<PR_NUMBER>

@vanessayuenn vanessayuenn added the build Internal-facing build tooling & test updates label Feb 29, 2024
@vanessayuenn vanessayuenn added ci:docs Run the CI jobs for documentation checks only. ci:normal and removed ci:docs Run the CI jobs for documentation checks only. labels Feb 29, 2024
Copy link
Member

@yannbf yannbf left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! I'm wondering if this is consumed elsewhere, where the link does help?

@vanessayuenn
Copy link
Contributor Author

LGTM! I'm wondering if this is consumed elsewhere, where the link does help?

I am not sure! @JReinhold do you know?

@JReinhold
Copy link
Contributor

JReinhold commented Mar 5, 2024

I don't think this should be solved at the data fetching layer but instead at the generation layer. pr.links.user would be misleading since it wouldn't actually contain a user link anymore.

I've changed the implementation to use pr.user instead of pr.links.user, let me know what you think @vanessayuenn, feel free to merge if you want to.

@vanessayuenn vanessayuenn merged commit a328c20 into next Mar 6, 2024
56 checks passed
@vanessayuenn vanessayuenn deleted the vy/changelog-contributors branch March 6, 2024 11:39
@github-actions github-actions bot mentioned this pull request Mar 6, 2024
13 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
build Internal-facing build tooling & test updates ci:normal
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants