GitHub Actions

This page is a live demo of how Polar can be integrated into your documentation or blog using the Polar API.

You can integrate Polar using the Polar GitHub Action or by using the Polar API directly.

The Polar GitHub Action is an GitHub Action (and standalone Python script) that you can add to your statically built websites build step or run regularly.

The action works by searching for HTML comments in the HTML or Markdown and replacing it with rendered data.

It can look like this: <!-- POLAR type=issues org=polarsource repo=polar limit=3 --> which will be replaced by a list of the top 3 issues from polarsource/polar.

In this case, it will be replaced by this block:

<!-- POLAR type=issues id=dzaalrfj org=polarsource repo=polar limit=3 -->

* [#897 v0.5 Roadmap: OSS Sponsorship 2.0 – $20.0 💰](https://github.com/polarsource/polar/issues/897)
* [#873 Can't use `redis 4.6.0` without connection pool leakage in worker](https://github.com/polarsource/polar/issues/873)
* [#225 Integrate Stripe Revenue Recognition](https://github.com/polarsource/polar/issues/225)

<!-- POLAR-END id=dzaalrfj -->

On subsequent executions the contents between the POLAR and POLAR-END tags will be replaced. The id is automatically generated and needs to be unique within a single document. It's used to help knowing where each section starts and ends.

type=issues

issues renders issues and their current pledged amount as a list.

Arguments

• org (required) – Organization to list issues from
• repo (optional) – Repository to list issues from
• limit (optional) – Defaults to 5
• sort_by (optional) - Defaults to "funding_goal_desc_and_most_positive_reactions" – Read more

Example

<!-- POLAR type=issues org=polarsource repo=polar limit=3 -->

<!-- POLAR type=issues id=dzaalrfj org=polarsource repo=polar limit=3 -->

* [#897 v0.5 Roadmap: OSS Sponsorship 2.0 – $20.0 💰](https://github.com/polarsource/polar/issues/897)
* [#873 Can't use `redis 4.6.0` without connection pool leakage in worker](https://github.com/polarsource/polar/issues/873)
* [#225 Integrate Stripe Revenue Recognition](https://github.com/polarsource/polar/issues/225)

<!-- POLAR-END id=dzaalrfj -->

Rendered 👇

• #897 v0.5 Roadmap: OSS Sponsorship 2.0 – $20.0 💰
• #873 Can't use redis 4.6.0 without connection pool leakage in worker
• #225 Integrate Stripe Revenue Recognition

type=backers-avatars

backers-avatars renders avatar images of backers and links to their GitHub profile

Arguments

• org (required) – Organization to list pledges to

Example

<!-- POLAR type=issues org=polarsource repo=polar limit=3 -->

<!-- POLAR type=pledgers id=jqfqrilw org=polarsource -->
<a href="https://github.com/birkjernstrom"><img src="https://avatars.githubusercontent.com/u/281715?v=4" width=100 height=100 /></a>
<a href="https://github.com/drunkwcodes"><img src="https://avatars.githubusercontent.com/u/36228443?v=4" width=100 height=100 /></a>
<a href="https://github.com/zegl"><img src="https://avatars.githubusercontent.com/u/47952?v=4" width=100 height=100 /></a>
<a href="https://github.com/emilwidlund"><img src="https://avatars.githubusercontent.com/u/10053249?v=4" width=100 height=100 /></a>

<!-- POLAR-END id=jqfqrilw -->

Rendered 👇