tk-sls.de/linuxfoo-gitlab
2
0
Fork 1
Code Releases 3 Activity

formatting and wording

Browse Source
This commit is contained in:
Tilman Kranz 2021-11-27 11:28:39 +01:00
parent 2fc79d3230
commit 2ff9c46600
1 changed files with 10 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@ -2,25 +2,28 @@
## Summary
Embed list of most recent commits to a Gitlab project from a Gitlab instance's public REST API.
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-list-commits`
### Example
Add `[gitlab-list-commits url=https://tk-sls.de/gitlab project_id=42 since="3 month" max=5]` for a list of at most 5 commits to that project that were made since at most 3 months ago.
Add the following shortcode to your post for a list of at most 5 commits to that project that were made since at most 3 months ago:
```
[gitlab-list-commits url="https://tk-sls.de/gitlab" project_id=42 since="3 months" max=5]
```
### 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`: List only commit from branch or reference name `STRING`.
* `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`: List only commit from branch or reference name `STRING` (examples: `main`, `v1.1`).
* `default_branch`: If set, list only commits from the project's default branch.
## Author and License
* Copyleft 2021 Tilman Kranz <[t.kranz@tk-sls.de](mailto:t.kranz@tk-sls.de)>
* License: MIT License [https://opensource.org/licenses/MIT](https://opensource.org/licenses/MIT)