Discourse GitHub

Plugin
, ,
1
:discourse2: Summary Discourse GitHub Allows staff to assign badges to users based on GitHub contributions. Also allows users to create Github Linkbacks and Permalinks
:open_book: Install Guide This plugin is bundled with Discourse core. There is no need to install the plugin separately.

Features

Github Badges

Assign badges to your users based on GitHub contributions.

How to use:
  1. Enable github badges enabled in Settings -> Plugins.
  2. Generate a GitHub access token and paste it into the github linkback access token setting. See below for instructions.
  3. Add one or more URLs of the GitHub repos to scan for contributions to the github badges repos site setting.
How badge counting works:

Badges count commits across all repositories, and when a user contributes to multiple repos, all their commits are added together into one total count.

Committer Badges:

  • Bronze: 1 commit
  • Silver: 25 commits
  • Gold: 1000 commits

Badge Progression: As users accumulate more contributions across any of the tracked repositories, they automatically progress through badge tiers. For example, if a user commits to Repo A and then Repo B, both contributions count toward their total, allowing them to progress from Bronze to Silver to Gold.

Github Linkback

Create a link from a Github pull request or commit back to a Discourse post where it is mentioned.

image
image797×194 14 KB

How to use:
  1. Enable github linkback enabled in Settings -> Plugins.
  2. Generate a GitHub access token and paste it into the github linkback access token setting. See below for instructions.
  3. Finally, add the projects you wish to post to in the github linkback projects site setting in the formats:
    • username/repository for specific repositories
    • username/* for all repositories of a certain user

Github Permalink

Replace Github non-permalinks with permalinks.

How to use:
  1. Enable github permalinks enabled in Settings -> Plugins.

Configuration

GitHub Access Token

In order for the linkback feature to work and the badges to be granted to your users, you need to provide a Github access token. You can generate your token here: Sign in to GitHub · GitHub.

The linkback feature requires the public_repo scope, and granting badges requires no scope (leave everything unchecked if you only want badges). Since the public_repo scope grants write access to repositories, we recommend you create a throwaway Github account that has access to no repositories and use it just to generate a token.

CHANGELOG

TODO

30 Likes
71

What is the process for multiple links? does it just add them to the same commit comment? or make a whole new comment every time?

1 Like
72

I wonder if commits and PRs badges could be simplified because we are trying to keep away The paradox of choice :slight_smile:

Currently I just forked and deleted commit badges but of course, I loss myself from the commit badge (because I’m commiting directly) and fork is not equal to keeping always with the core.

73

The wildcard * didn’t work for me for a GitHub organization, I ended up putting in every repo individually. Has anyone else had issues with this with an organization vs. a user?

74

How to set the linkback comment language?

75

Thank you, I really like this plugin! I was confused about the badges system and was glad to find the explanation in a different topic: Github Badges are not working. Its hard to see if I do something wrong or if the plugin is not working - #4 by simon

However, that reply notes that

The plugin creates 6 badges:

I don’t see any of these badges, not sure what happened? Is there a way to (re?)trigger the creation of these badges?

1 Like
76

To answer my own question, after a few hours the scheduled task ran and that’s when the badges got created.

The manual way to do this would be to trigger the sidekiq job it seems.

1 Like
77

Feature Request: exclude categories and/or tags from linkback

We have an Announcements category into which the RSS Plugin automatically pulls new GitHub releases. When the release notes link to issues, that link also appears in Discourse and a linkback is created, but one that is not helpful to anyone, creating clutter on Github.

I would like to be able to exclude certain posts, i.e. categories or tags or even just posts from the user that is configured in the RSS Plugin, from creating linkbacks.

78

:partying_face: This plugin is now bundled with Discourse core as part of Bundling more popular plugins with Discourse core. If you are self-hosting and use the plugin, you need to remove it from your app.yml before your next upgrade.