mathieudutour / mathieudutour/github-tag-action

pre_release_branches default to catchall

Open
#139 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
TypeScript
Stars
733
Forks
227
PR merge metrics
No merged PRs in 30d

Description

The option pre_release_branches defaults to ``, but you are using `.match` which always returns true when passed an empty string.

```
branch = "anything";
Boolean(branch.match('')) # always true
```

https://github.com/mathieudutour/github-tag-action/blob/v6.0/src/action.ts#L58

We use this behavior but it is not intuitive (maybe documentation should be updated to say that all branches are prerelease).

Contributor guide

Open the contributing guide

Research direction

Start at src/action.ts#L58 and review how an empty pre_release_branches value is matched. Then find the option's documentation and explain that the default empty value treats all branches as prerelease branches. Done means the documented behavior matches the implementation and the default is clear to users.

Written by the indexing model from the issue text.

Assessment

Tech stack
github-actions, typescript
Domain
ci-cd
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.