Panegyric

Description

Panegyric is a WordPress plugin for displaying Github Pull Requests created by a list of organisations and/or users.
It’s main usage is for an organisation or user to show off all the cool stuff they’ve done for open source projects.

To use it, add the github_prs shortcode to a page. Simplest form is [github_prs orgs="lshift"] (replace lshift with your Github organisation name).

Additional parameters are supported as follows:

  • orgs: Comma-separated list of organisations. Optional, but if you omit this and users, it won’t do anything. Default is ""
  • users: Comma-separated list of users. Optional, but as per orgs, it’s kinda recommended. Default is "".
  • limit: Number of Pull Requests to show. Default is 10.
  • format: Format of items. Default is {$updated_at}: "<a href="{$pr_url}">{$pr_title}</a>" was done by <a href="{$user_url}">{$name}</a> for <a href="{$repo_url}">{$repo_name}</a>. The various ${variables} in the default format are all the ones supported currently.

For format, if you want to include " characters, you should write it with single quotes on the outside, and not do escaping. This is actually a WordPress problem, but it doesn’t unfortunately do a nice error message, it just fails!

The list of pull requests is determined as follows:

  1. For every organisation, get all their public users.
  2. Add that to the list of users.
  3. For each user, get all their merged pull requests.
  4. List in reverse date order every Pull Request that’s not in the user list or the orgs list. Stop when you hit the limit.

The data for these requests are updated once per day (or when someone clicks the relevant date field on the admin page), via the magic of WP Cron (the standard WordPress update mechanism). You will need to manually update people when you first add them, but the plugin will bug you about that.

Lists have the CSS class panegyric-list and the items have the class panegyric-item.

Installation

  1. install the plugin through the WordPress plugins screen

FAQ

Where is development for this plugin done?

At https://github.com/palfrey/panegyric

Reviews

Read all 1 review

Contributors & Developers

“Panegyric” is open source software. The following people have contributed to this plugin.

Contributors

Translate “Panegyric” into your language.

Interested in development?

Browse the code, check out the SVN repository, or subscribe to the development log by RSS.

Changelog

1.2

  • Fix table pagination (#14)
  • Use WordPress HTTP, not Curl (#18)
  • Test with WordPress 5 (#16)
  • Default to using usernames if we don’t have an actual name for a user (#15)
  • Replace “never” entries in lists with “(Click to update)” (#12)
  • Only require PRs to be updated before not complaining (#11)

1.1

  • Remove users that aren’t in an organisation any more
  • Fix spelling of panegyric in the item list

1.0

  • Initial version