glmap: Wikipages

As in GitHub, we can create a wiki in GitLab and separate it into different pages. The only difference is that in GitLab, we can comment a page. For more information on what you can do with wikis in GitLab, see the GitLab documentation.

The following table shows the mapping of the events generated by GitLab for wikis. A fully detailed mapping can be found below.

Action	target_type	action	detection
CreateWikiPage	WikiPage::Meta	created
DestroyWikiPage	WikiPage::Meta	destroyed
UpdateWikiPage	WikiPage::Meta	updated
CreateWikiPageComment	WikiPage::Meta	Note	note.noteable_type: WikiPage::Meta

Activity	Actions	time window
ManageWikiPages	- CreateWikiPage - Opt - Rep - DestroyWikiPage - Opt - Rep - UpdateWikiPage - Opt - Rep	3600s
CommentWikiPages	- CreateWikiPageComment - Rep	3600s

1 - Actions

• Detection are the values used to detect what action has been performed.
• Details are information found in the payload of the event that can be used to group actions to activities. (name_in_action = name_in_payload)

1.1 - CreateWikiPage

Triggered when a wiki page is created.

Detection:

• action_name = created
• target_type = WikiPage::Meta

Details:

• wiki_page.title = target_title
• wiki_page.slug = wiki_page.slug (URL friendly title)
• wiki_page.format = wiki_page.format
• wiki_page.id = target_id (ID overall)
• wiki_page.iid = target_iid (ID in the project)

1.2 - DestroyWikiPage

Triggered when a wiki page is deleted.

Detection:

• action_name = destroyed
• target_type = WikiPage::Meta

Details:

• wiki_page.title = target_title
• wiki_page.slug = wiki_page.slug (URL friendly title)
• wiki_page.format = wiki_page.format
• wiki_page.id = target_id (ID overall)
• wiki_page.iid = target_iid (ID in the project)

1.3 - UpdateWikiPage

Triggered when a wiki page is updated.

Detection:

• action_name = updated
• target_type = WikiPage::Meta

Details:

• wiki_page.title = target_title
• wiki_page.slug = wiki_page.slug (URL friendly title)
• wiki_page.format = wiki_page.format
• wiki_page.id = target_id (ID overall)
• wiki_page.iid = target_iid (ID in the project)

1.4 - CreateWikiPageComment

Triggered when a comment is made on a wiki page. We can't create a thread on a wiki page.

Detection:

• action_name = commented on
• target_type = Note
• note.noteable_type = WikiPage::Meta

Details:

• wiki_page.title = target_title
• wiki_page.slug = wiki_page.slug (URL friendly title)
• wiki_page.format = wiki_page.format
• wiki_page.id = target_id (ID overall)
• wiki_page.iid = target_id (ID in the project)
• comment.id = note.id (CommentID overall)
• comment.body = note.body

2 - Activities

Each activity is composed of one or more actions. Each action can be repeatable and can be optional. A maximum time window is also defined for each activity and it is used to group actions that are close to each other in time.

For each action, we can define a verification function (validate_with) to make sure that the action is part of the activity. (e.g comments are made on the same issue)

2.1 - ManageWikiPages

time_window = 3600s

This is based on ghmap's mapping. We group all modifications to a wiki of a repository in a single activity.

Actions:

• CreateWikiPage - optional and repeatable
• DestroyWikiPage - optional and repeatable
• UpdateWikiPage - optional and repeatable

2.2 - CommentWikiPages

time_window = 3600s

Based on the idea to group all activities made on a wiki, we group all comments made on the same repository in a single activity.

Actions:

• CreateWikiPageComment - repeatable