semantic-release / semantic-release/github

release failure issue failing to be opened

Open
#1,065 5 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

bug Good first issue help wanted
Dominant language
JavaScript
Stars
534
Forks
150
Avg merge
1m
Merged PRs (30d)
3

Description

While working through semantic-release/npm#958, i had several situations where my configuration was not yet working, so semantic-release attempted to open the issue in the repo to report the release failure. an example failure can be found in https://github.com/travi-test/npm-oidc-test/actions/runs/16186374845/job/45692725649#step:5:106

it appears that the way we are creating the issue is failing some sort of validation of labels on the github api side. unfortunately, the error gets collapsed to prevent the error from being obvious, so i havent dug deeper to understand the issue further: https://github.com/travi-test/npm-oidc-test/actions/runs/16186374845/job/45692725649#step:5:188

the issue gets created with octokit.request and i dont see anything obvious when comparing to the rest api doc: https://github.com/semantic-release/github/blob/ecde3a8a58a7cda1ddb8d405d049f56d223afe23/lib/fail.js#L100

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with lib/fail.js around line 100 and reproduce the failure using the linked GitHub Actions run. Compare the octokit.request call with GitHub's create-an-issue REST API documentation, focusing on label validation. Done means a release failure can open its reporting issue successfully and the API error is no longer hidden.

Written by the indexing model from the issue text.

Assessment

Tech stack
github, javascript
Domain
api, release
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.