search

executablebooks / github-activity

Simple markdown changelogs for GitHub repositories
https://github-activity.readthedocs.io/en/latest/
BSD 3-Clause "New" or "Revised" License
47 stars 11 forks source link

Make github friendly outputs #82

Closed choldgraf closed 1 year ago

choldgraf commented 1 year ago

Currently we create a "list of contributors" that includes usernames that are markdown links. So for example:

[@username](https:--some-link)

Many people use this package to copy/paste into their GitHub release notes description. For example:

https://github.com/pydata/pydata-sphinx-theme/releases/tag/v0.13.0rc3

GitHub has a special way of parsing that description, and generates its own "contributors to this release". This generates a nice little viz like this:

image

However, the usernames are only valid for this if the username is plain-text and not linked. So:

@choldgraf  <-- will be picked up
[@choldgraf](foo) <-- will not be picked up

This means many people don't make it into the github description for contributors.

So this PR slightly re-works our "all contributors" output to include plain-text versions of each username (and an activity link). That way it can be directly copy/pasted into GitHub descriptions.

Probably the easiest way to see what this does is to look at the updated regression tests:

https://github.com/executablebooks/github-activity/pull/82/files#diff-6c54192b8d2c9fe6985b500f05688bd1b18142b3d0e8d421d37bcded866c40aeR23

choldgraf commented 1 year ago

@minrk any chance you'd take a look at this one quickly since you're thinking about github-activity already? :-)

minrk commented 1 year ago

Makes sense!