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

Remove # from episode numbers in commit messages #513

Merged
merged 1 commit into from
Jun 4, 2024
Merged

Remove # from episode numbers in commit messages #513

merged 1 commit into from
Jun 4, 2024

Conversation

br3ndonland
Copy link
Contributor

Description

@changelogbot keeps show notes, transcripts, and other content up to date. It creates commit titles like Add Changelog & Friends #46.

On changelog.com, referring to episodes like Changelog & Friends #46 is no problem. GitHub, however, will autolink these episode references and think they are issue or PR numbers.

For example, here's a commit (thechangelog/show-notes@076c238) referencing a PR that has nothing to do with the show notes being committed:

Screenshot of thechangelog-show-notes showing that a commit title is autolinked to a PR

Changes

lib/changelog/github/source.ex appears to be where the leading # is added.

defp name(episode), do: "#{episode.podcast.name} ##{episode.slug}"

This PR will update lib/changelog/github/source.ex to remove the leading # and avoid having GitHub autolink the episode numbers.

WDYT?

Did I fix the right thing?

Will this break other stuff I don't know about?

@changelogbot keeps show notes, transcripts, and other content up to
date. It creates commit titles like `Add Changelog & Friends #46`. On
changelog.com, referring to episodes like `Changelog & Friends #46` is
no problem. GitHub, however, will autolink these episode references and
think they are issue or PR numbers.

For example, here's a commit
(thechangelog/show-notes@076c238) referencing
a PR that has nothing to do with the show notes being committed.

This commit will update `lib/changelog/github/source.ex` to remove the
leading `#` and avoid having GitHub autolink the episode numbers.
@jerodsanto jerodsanto merged commit cb50584 into thechangelog:master Jun 4, 2024
4 checks passed
@jerodsanto
Copy link
Member

Works for me. @all-contributors please add @br3ndonland for code

Copy link
Contributor

@jerodsanto

I couldn't determine any contributions to add, did you specify any contributions?
Please make sure to use valid contribution names.

I've put up a pull request to add @br3ndonland! 🎉

@br3ndonland br3ndonland deleted the fix-github-autolinks branch June 5, 2024 01:17
@gerhard
Copy link
Member

gerhard commented Jun 9, 2024

That's amazing attention to detail @br3ndonland 🤓

I love that you captured all the context that was needed to make approving this super straightforward.

Will be giving this PR a shout in the next Kaizen:

Thank you 🙌

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.

3 participants