gh_issue_formatters: GitHub issue formatters

Description Usage Arguments Details Value

Description

Functions formatting GitHub issue data. They are vectorized so multiple tickets can be processed.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
gh_issue_body(id, description, reporter, owner, time, changetime, type,
  priority, keywords)

gh_issue_title(id, summary)

gh_issue_milestone(number)

gh_issue_labels(type, priority)

trac_link_ticket(id, base_url = getOption("trac2gh.base_url"))

Arguments

id, description, reporter, owner, time, changetime, keywords

character Trac ticket metadata

type, priority

character, Trac ticket type and priority

summary

character, Trac ticket summary (aka title)

number

GH issue number

base_url

character, base URL to Trac instance

Details

Function gh_issue_body creates the GH issue body based on Trac ticket description and other metadata. The text is transformed from MoinMoin wiki markup to Markdown using a rather rudimentary parser moinmoin_to_markdown. The body is prepended with a "header" containing original metadata from Trac.

gh_issue_title creates issue title from Trac ticket summary prepending Trac ticket id in square brackets.

gh_issue_labels creates labels based on Trac ticket priority and type. Label names are have a format p:foo and t:bar for tickets of priority "foo" and type "bar".

trac_link_ticket creates URL to a ticket on Trac.

Value

gh_issue_body returns a character vector with issue body in Markdown.

gh_issue_title returns a formatted issue title composed of original ticket summary and id.

gh_issue_labels returns a list of labels for every ticket.

trac_link_ticket returns a vector of URLs.


mbojan/trac2gh documentation built on May 22, 2019, 12:56 p.m.