LearnNewsExamplesServices
Frontmatter
id7368
titleEnhance Issue Creation Script to Sync GitHub ID back to Markdown File
stateClosed
labels
enhancementhelp wantedgood first issuehacktoberfestai
assigneesLemonDrop847
createdAtOct 5, 2025, 12:54 PM
updatedAtOct 5, 2025, 7:49 PM
githubUrlhttps://github.com/neomjs/neo/issues/7368
authortobiu
commentsCount3
parentIssue7364
subIssues[]
subIssuesCompleted0
subIssuesTotal0
blockedBy[]
blocking[]
closedAtOct 5, 2025, 7:49 PM

Enhance Issue Creation Script to Sync GitHub ID back to Markdown File

Closed v11.0.0 enhancementhelp wantedgood first issuehacktoberfestai
tobiu
tobiu commented on Oct 5, 2025, 12:54 PM

After a GitHub issue is created from a local markdown ticket, the new GitHub issue ID and URL need to be written back into the markdown file. This closes the loop and creates a permanent, version-controlled link between the two. This ticket is to enhance the createGhIssue.mjs script to perform this write-back operation.

Acceptance Criteria

  1. The createGhIssue.mjs script is modified.
  2. After successfully creating a GitHub issue, the script must capture the new issue's URL from the stdout of the gh issue create command.
  3. The script will then read the original markdown ticket file.
  4. It will replace the placeholder GH ticket id: #<number> with the new issue URL and ID (e.g., GH ticket id: #1234 and add the URL on a new line).
  5. This ensures the local ticket is always synchronized with its remote counterpart on GitHub.
tobiu added the enhancement label on Oct 5, 2025, 12:54 PM
tobiu added the help wanted label on Oct 5, 2025, 12:54 PM
tobiu added the good first issue label on Oct 5, 2025, 12:54 PM
tobiu added the hacktoberfest label on Oct 5, 2025, 12:54 PM
tobiu added parent issue #7364 on Oct 5, 2025, 12:54 PM
tobiu added the ai label on Oct 5, 2025, 12:54 PM
LemonDrop847
LemonDrop847 Oct 5, 2025, 2:08 PM

Would like to have a go at this as well!

LemonDrop847
LemonDrop847 Oct 5, 2025, 2:25 PM

I believe this file isn't yet created maybe dependent on some other issue

tobiu assigned to @LemonDrop847 on Oct 5, 2025, 3:55 PM
tobiu
tobiu Oct 5, 2025, 3:55 PM

sure. assigned.

more input from gemini:

Formal Blocker: The task is officially blocked by the Phase 1 ticket: ticket-setup-github-cli-authentication.md. The script's primary function is to communicate with the GitHub API via the gh CLI, which requires an authenticated environment. We haven't yet created the guide that explains how to set this up.

Practical Path Forward: The contributor, LemonDrop847, can start working on this immediately if they are comfortable doing the following without waiting for our official guide:

  1. Independently install the GitHub CLI.
  2. Independently run gh auth login to authenticate their environment.

Recommendation: The ticket is available to be worked on, but it would be helpful to communicate to LemonDrop847 that they will need to set up and authenticate the gh CLI on their own as a first step, since the official project documentation for that process doesn't exist yet.

LemonDrop847 cross-referenced by #7377 on Oct 5, 2025, 5:51 PM
tobiu closed this issue on Oct 5, 2025, 7:49 PM
LemonDrop847 referenced in commit 5a7495c - "Merge pull request #7380 from LemonDrop847/feat/issue-creation-script-sync-ghID-to-MD on Oct 5, 2025, 8:04 PM