EG Repo Card

Description

EG Repo Card shows a compact card for a code repository hosted on GitHub, Codeberg or any Forgejo or Gitea instance. Add the shortcode with the repository address and the card shows:

• repository name, platform logo and description
• buttons for the project website, the source code and the latest release download
• last update date (the time since the update appears on hover)
• latest version, from the latest release or, when there are none, the latest git tag
• main language, license and star count
• an “Archived” label for read-only repositories

The same shortcode works with plugins from the WordPress.org directory. Their card shows the plugin name, icon and description, the plugin page, the download of the latest version, the WordPress version it is tested up to, the active installations and the average rating. Closed plugins get a “Closed” label.

The card adapts to your theme: card and buttons can use a neutral preset, a transparent background, a custom color, or follow the light or dark mode of the visitor browser. Text and icons always stay readable on the chosen background.

Repository data is cached. If the platform does not answer, the card keeps showing the last data it received; visitors never see an error message.

Usage

Insert the shortcode in any post, page, or widget:

[eg-repo-card url=”https://github.com/WordPress/wordpress-develop”]
[eg-repo-card url=”https://codeberg.org/forgejo/forgejo”]
[eg-repo-card url=”https://git.emanuelegori.uno/emanuelegori/eg-repo-card”]
[eg-repo-card url=”https://wordpress.org/plugins/akismet/”]

The address is the one you see in the browser on the repository or plugin page. For Forgejo and Gitea, any instance works, self-hosted ones included.

External services

To build a card, the plugin asks the platform that hosts the repository or the plugin for its public data. It contacts only the hosts written in the shortcodes on your site, from your server, and only when a page with a card is displayed and the cached data has expired. No data about your visitors is sent.

GitHub

• What: the GitHub REST API (host api.github.com), used to read the data of a public GitHub repository.
• When: when a page with a GitHub card is displayed and the cached data has expired.
• Requests: /repos/{owner}/{repo}, /repos/{owner}/{repo}/releases/latest and, when there are no releases, /repos/{owner}/{repo}/tags.
• Data sent: the owner and name of the repository, and the personal access token if you saved one.
• Data received: public repository data (description, website, stars, language, license, latest release and tag).
• Terms of service: https://docs.github.com/en/site-policy/github-terms/github-terms-of-service
• Privacy statement: https://docs.github.com/en/site-policy/privacy-policies/github-general-privacy-statement

Codeberg

• What: the Codeberg API (host codeberg.org, path /api/v1), used to read the data of a public Codeberg repository.
• When: when a page with a Codeberg card is displayed and the cached data has expired.
• Requests: the same as for Forgejo and Gitea instances, below.
• Data sent: the owner and name of the repository, and the Forgejo token if you saved one.
• Data received: public repository data (description, website, stars, language, license, latest release and tag).
• Terms of use: https://codeberg.org/codeberg/org/src/branch/main/TermsOfUse.md
• Privacy policy: https://codeberg.org/codeberg/org/src/branch/main/PrivacyPolicy.md

Forgejo and Gitea instances

Forgejo and Gitea are free software that anyone can host; there is no central service. The plugin contacts only the instance whose address the site owner writes in a shortcode (for example git.emanuelegori.uno in [eg-repo-card url="https://git.emanuelegori.uno/emanuelegori/eg-repo-card"]), through the instance’s own API.

• What: the API of that instance, used to read the data of a public repository hosted there.
• When: when a page with a card from that instance is displayed and the cached data has expired.
• Requests: /api/v1/repos/{owner}/{repo}, /api/v1/repos/{owner}/{repo}/releases and, when there are no releases, /api/v1/repos/{owner}/{repo}/tags. Once a week per instance, /api/forgejo/v1/version, only to tell Forgejo from Gitea and show the right logo.
• Data sent: the owner and name of the repository, and the Forgejo or Gitea token if you saved one.
• Data received: public repository data (description, website, stars, language, license, latest release and tag).
• Terms of service and privacy policy are those of the chosen instance, published by whoever runs it.

WordPress.org

• What: the WordPress.org plugin directory API (host api.wordpress.org, path /plugins/info/1.2/), used to read the data of a plugin listed in the directory.
• When: when a page with a WordPress.org plugin card is displayed and the cached data has expired.
• Data sent: the slug of the plugin. No token is used.
• Data received: public plugin data (name, description, icon, version, last update, tested WordPress version, active installations, rating, download link).
• Privacy policy: https://wordpress.org/about/privacy/

Owner avatar and plugin icon

The image is off by default. When you enable it, visitors’ browsers load the owner’s avatar or the plugin icon directly from the platform that hosts it (GitHub, Codeberg, the Forgejo or Gitea instance, or WordPress.org), which receives the visitor’s IP address like for any image request.