intuit / intuit/auto

skip-release label ignored with auto shipit in PRs

Open
#1,501 8 comments 2 reactions 0 assignees View on GitHub
bug hacktoberfest
Dominant language
TypeScript
Stars
2.5k
Forks
221
PR merge metrics
No merged PRs in 30d

Description

**Describe the bug**

I am currently running `npx auto shipit` from a CircleCI job. When I apply the `skip-release` label to a Pull Request, `auto` is still publishing a `canary` version of the package.

**To Reproduce**

1. Open a Pull Request in GitHub UI
2. Apply the `skip-release` label to the PR
3. Finish creating the PR

**Expected behavior**

I expect `auto` to skip the `canary` release for the package.

**Screenshots**
In the screenshot below, you can see the `skip-release` label is added but the PR description has the message appended with details about the released `canary` package.

Screen Shot 2020-08-28 at 1 05 54 PM

**Environment information:**

```txt
Environment Information:

"auto" version: v9.52.0
"git" version: v2.20.1 (Apple Git-117)
"node" version: v10.15.1

Project Information:

✔ Repository: TangoGroup/react-components (​https://github.com/TangoGroup/react-components​)
✔ Author Name: Sean Connolly
✔ Author Email: sconnolly17@gmail.com
✔ Current Version: v0.0.5
✔ Latest Release: v0.0.5 (​https://github.com/TangoGroup/react-components/releases/tag/v0.0.5​)

✖ Labels configured on GitHub project (Try running "auto create-labels")

GitHub Token Information:

✔ Token: [Token starting with 8ed9]
✔ Repo Permission: admin
✔ User: goldenshun
✔ API: undefined (​undefined​)
✔ Enabled Scopes: repo
✔ Rate Limit: 4700/5000
```

**Additional context**

I am not sure why `npx auto info` is saying my labels are not configured in GitHub. I did run `auto create-labels` and continue to experience the issue.

`.autorc` file:
```
{
"plugins": ["npm", "slack"],
"labels": [
{
name: "major",
changelogTitle: "💥 Breaking Change",
description: "Increment the major version when merged",
releaseType: "major",
},
{
name: "minor",
changelogTitle: "🚀 Enhancement",
description: "Increment the minor version when merged",
releaseType: "minor",
},
{
name: "patch",
changelogTitle: "🐛 Bug Fix",
description: "Increment the patch version when merged",
releaseType: "patch",
},
{
name: "skip-release",
description: "Preserve the current version when merged",
releaseType: "skip",
},
{
name: "documentation",
changelogTitle: "📝 Documentation",
description: "Changes only affect the documentation",
releaseType: "none",
},
]
}
```

Contributor guide

No contributing guide indexed for this repository

Research direction

Start at the `npx auto shipit` entry point and trace how the PR's `skip-release` label is handled during canary publishing. Reproduce the CircleCI scenario using the supplied `.autorc` configuration; done means a labeled PR no longer publishes a canary release and the behavior is covered by an appropriate test.

Written by the indexing model from the issue text.

Assessment

Tech stack
github, typescript
Domain
ci-cd, release
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.