linuxfoo-gitlab/README.md

1.7 KiB

linuxfoo-gitlab

Summary

Embed a list of the most recent commits to a Gitlab project. Information is retrieved from a specified Gitlab instance's public REST API.

Shortcode gitlab-show-project

Examples

Add the following shortcode for a list of at most 5 commits to that project that were made since at most 3 months ago:

[gitlab-show-project url="https://tk-sls.de/gitlab" project_id=42 since="3 months" max=5]

Add the following shortcode for a list of at most 3 commits followed by a link to the latest release:

[gitlab-show-project url="https://tk-sls.de/gitlab" project_id=42 max=3 release="latest"]

Attributes

  • url="STRING": Mandatory (example: https://tk-sls.de/gitlab).
  • project_id=NUM: Mandatory; NUM: Positive Integer, valid project ID in Gitlab specified by url (example: 42).
  • since="NUM UNIT": Optional; NUM: Positive integer; UNIT: days, months, years; exclude commits older than specified time interval (example: 3 months).
  • max=NUM: Optional; NUM: Positive integer; list not more than NUM commits (example: 5).
  • ref_name=STRING: Optional: list only commit from branch or reference name STRING (examples: main, v1.1).
  • default_branch: Optional; if set, list only commits from the project's default branch.
  • release=STRING: Optional; if set, STRING can be either all (show a list of all releases of this project) or latest (show a link to the latest release of this project, if any).

Author and License