DokuWiki

It's better when it's simple

User Tools

Site Tools


plugin:gitlabapi

gitlabapi Plugin

Compatible with DokuWiki

  • 2022-07-31 "Igor" yes
  • 2020-07-29 "Hogfather" unknown
  • 2018-04-22 "Greebo" unknown
  • 2017-02-19 "Frusterick Manners" unknown

plugin GitLab-Api displays some information from a GitLab project.

Last updated on
2023-01-19
Provides
Syntax
Repository
Source

Tagged with code, git, gitlab, projects

By mozgan

:!: This plugis is an extended version of Gitlab-Project. All thanks to algorys.

Installation

Search and install the plugin using the Extension Manager.

Configuration

The following values must be configured in the Configuration Manager:

  • server.default: Set your default GitLab url without slash ending. You can override this setting in server.json file.
  • token.default: Fill your admin token. You can override this setting in server.json file.

Syntax

Default Syntax

<gitlab-api project-path="<NAMESPACE>/<SUB_DIRS>/<PROJECT_NAME>" />
  • NAMESPACE is the namespace of your project.
  • SUB_DIRS is the sub-directories of your project if exists.
  • PROJECT_NAME is the name of your project.

For instance, if your project is available at http://gitlab.domain.com/ns/dir1/dir2/project, then the syntax should be:

<gitlab-api project-path="ns/dir1/dir2/project" />

Display Information

The plugin displays following information:

  • milestones=“n” lists the latest n milestones.
  • commits=“n” lists the latest n commits.
  • issues=“n” lists the latest n issues.
  • pipelines=“n” lists the latest n pipelines.

For instance, if you want to see the latest 3 milestones, 10 commits, 5 issues, and 10 pipelines, then the syntax will be:

<gitlab-api project-path="ns/dir/project" commits="10" issues="5" milestones="3" pipelines="10" />

Override Server and Token

There a JSON file server.json inside the root of plugin. You can add or change the servers and their tokens.

For instance; you have a GitLab server namely gitlab.home and following JSON file:

{
  "gitlab.home": {
    "url": "http://192.168.0.10",
    "token": "aabbccddeeffgghh"
  }
}

Then you can use server parameter as follows:

<gitlab-api server="gitlab.home" project-path="ns/project" />

Change Log

Known Bugs and Issues

Please report youe issues or your idea at GitLab-Api.

plugin/gitlabapi.txt · Last modified: 2023-01-19 12:33 by mozgan

Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International
CC Attribution-Share Alike 4.0 International Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki