issues

Github, Jira, Gitlab issues from Plan 9's acme
Log | Files | Refs | README | LICENSE

doc.go (821B)

      1 /*
      2 Package jira provides a virtual read-only filesystem interface to
      3 issues from a Jira issue tracker via the [Jira REST API]. Projects,
      4 issues and comments are presented as a files and directories from a
      5 filesystem implementing [fs.FS].
      6 
      7 The filesystem root holds project directories.
      8 Within each project are the project's issues, one directory entry per issue.
      9 The filepaths for issues TEST-1, TEST-2, and WEB-27 would be:
     10 
     11 	TEST/1
     12 	TEST/2
     13 	WEB/27
     14 
     15 Each issue directory has a file named "issue"
     16 holding a textual representation of the issue and a listing of comments.
     17 For example, TEST/1/issue.
     18 
     19 Comments are available as numbered files alongside the issue file.
     20 Comment 69 of issue TEST-420 can be accessed at TEST/420/69.
     21 
     22 [Jira REST API]: https://developer.atlassian.com/cloud/jira/platform/rest/v2/
     23 */
     24 package jira