Make github friendly outputs #82
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Member
Author
|
@minrk any chance you'd take a look at this one quickly since you're thinking about github-activity already? :-) |
Collaborator
|
Makes sense! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Currently we create a "list of contributors" that includes usernames that are markdown links. So for example:
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:
However, the usernames are only valid for this if the username is plain-text and not linked. So:
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
activitylink). 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