issues

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

doc.go (2029B)

      1 /*
      2 Issue is a client for reading issues in a GitHub repository from the Acme editor.
      3 
      4 	usage: issue [-p owner/repo]
      5 
      6 The default owner/repo is golang/go.
      7 
      8 # Authentication
      9 
     10 Issue expects to find a GitHub "personal access token" in
     11 $HOME/.config/github/token
     12 and will use that token to authenticate
     13 to GitHub when reading or writing issues.
     14 
     15 # Acme Editor Integration
     16 
     17 Issue serves a synthetic read-only filesystem consisting of issues and any comments made on them as a tree.
     18 
     19 Navigating the issue tree is similar to navigating regular filesystems in Acme.
     20 
     21 The root directory contains references to all issues of the repository,
     22 one directory per issue named after the issue number.
     23 
     24 Each issue directory contains the following files:
     25 
     26   - issue - holds a text representation of the issue in a format similar to an email message.
     27   - comments - a directory containing numbered files for each comment made on the parent issue. Each contains a text representation of the comment in the same format as issue files.
     28 
     29 Reading issue 28 from the file "28/issue" will yield something like the below:
     30 
     31 	Title: scte35: support decoding splice_schedule command type
     32 	State: open
     33 	From: ollytom
     34 	Date: 2024-11-30 02:30:57
     35 	Assignee:
     36 	Labels:
     37 	URL: https://github.com/untangledco/streaming/issues/28
     38 
     39 	We support encoding splice_schedule commands (see
     40 	`packEvents`), but we don't support decoding them yet. For
     41 	consistency, we could have two functions, `unpackEvent` and
     42 	`unpackEvents` in command.go after `packEvent`.
     43 
     44 To load comment 2508795164 made on issue 28, open the file "28/comments/2508795164":
     45 
     46 	From: ollytom
     47 	Date: 2024-11-30 02:30:56 +0000 UTC
     48 
     49 	> Have you ever seen one in the wild?
     50 
     51 	Haha good question! Never actually now that I think about it.
     52 
     53 	>  I dropped support for Splice Schedule.
     54 
     55 	Not a bad idea. At least could store it as raw byte slice.
     56 
     57 	Thanks for reaching out :) Any other tips?
     58 
     59 Executing "Get" reloads a file's (either regular file or directory listing) backing data via the GitHub API.
     60 */
     61 package main