You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.adoc
+24-3Lines changed: 24 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,12 +7,17 @@
7
7
:append_or_impose: Prepend items with `+` to indicate they should be appended to existing labels. Items without `+` will only be used for issues with no `tags` designated.
8
8
ifdef::env-github[]
9
9
:icons: font
10
+
:caution-caption: :fire:
11
+
:important-caption: :exclamation:
12
+
:note-caption: :paperclip:
13
+
:tip-caption: :bulb:
14
+
:warning-caption: :warning:
10
15
endif::[]
11
16
12
17
13
18
== Overview
14
19
15
-
_Issuer_ lets you define all your work tickets in one place as YAML, apply defaults, and post them to GitHub Issues in bulk.
20
+
_Issuer_ lets you define all your GitHub Issues work tickets in one place as YAML, apply defaults, and post them to GitHub Issues in bulk.
16
21
17
22
=== Features
18
23
@@ -28,6 +33,22 @@ Future plans include extending this capability to *Jira*, *GitLab* Issues, GitHu
28
33
29
34
toc::[]
30
35
36
+
=== Who Is This For?
37
+
38
+
This tool is oriented as much for _project managers_ as it is for _software developers_, but the target audience is probably *people who manage software development cycles*, especially using Git tools.
39
+
40
+
So if you are a project manager, _product_ manager, technical writer or other role that participates in the _planning_ of _any_ kind of project.
41
+
42
+
[NOTE]
43
+
Ironically, issuer does not require be installed on your local workstation.
44
+
The only direct use of Git would be if you commit and share the batch-configuration file with your team.
45
+
46
+
This tool is great at creating "`stub`" issues for entire teams, based on user-story documents, task lists, or other planning documents.
47
+
Once you convert such documents to our special YAML-based definition format (IMYML), use `issuer` to post them to your GitHub Issues system via GitHub's API.
48
+
49
+
Individual issue entries can be as basic or as detailed as you wish.
50
+
They may consist of as little as just a title (summary) line, or that plus an assignee responsible for filling out the rest and add metadata.
51
+
Or they can be complete with labels, milestones, a type designation, and a complete explanation of the issue.
31
52
32
53
== Installation
33
54
@@ -453,7 +474,7 @@ Logs are simply kept for easy reversal of mis-postings.
453
474
I developed the 0.1.0 version of this application after trying to use GitHub Copilot to automatically bulk-create issue tickets, which it promises to be able to do but failed me pretty hard at it.
454
475
455
476
That facility seems like a perfectly inappropriate use of generative AI.
456
-
It accepted my plan request and pre-drafted ticket content, but then it wanted me to manually add labels and milestones to them, as well as manually click *create* on each one -- even though I had already taken the time to plan and instruct the milestones and labels and the contents were fullly prepared.
477
+
It accepted my plan request and pre-drafted ticket content, but then it wanted me to manually add labels and milestones to them, as well as manually click *create* on each one -- even though I had already taken the time to plan and instruct the milestones and labels and the contents were fully prepared.
457
478
458
479
Additionally, I find myself using different issue-management systems (Jira, GitLab Issues, etc), so I wanted a more platform-agnostic way to handle this problem.
459
480
With that in mind, I have left the Ruby API and the IMYML model fairly "`generic`" for extensibility.
@@ -462,7 +483,7 @@ I will probably adapt the API to other systems in future releases, and I welcome
462
483
=== Methodology Confession
463
484
464
485
I should note up front that this is the closest I have come to "`vibe coding`" anything bigger than a local script, let alone shippable production code.
465
-
Nevertheless, I intervened to make substantial and specific changes at least 100 times, and I rearranged major aspects of the codebase.
486
+
Nevertheless, I intervened to make substantial and specific changes at least 100 times before the 0.1.0 release alone, and I rearranged major aspects of the codebase.
466
487
467
488
I designed the IMYML format and the CLI up front, then I let Claud 4 (via GH Copilot) draft most of the code.
468
489
It committed lots of rookie mistakes during this process, and it even confessed to "`cargo-cult programming`" when I pointed out it was introduing some anti-patterns.
0 commit comments