mathieudutour / mathieudutour/github-tag-action
Support gitmoji commits
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 733
- Forks
- 227
- PR merge metrics
- No merged PRs in 30d
Description
Thanks for creating this great action!
I would like to use is with [gitmoji](https://gitmoji.dev/) based commits like `📝(README): Updated README with info`, but it seems not possible with the current separators.
As the above example, which refers to the `docs:` conventional commits type, can also be represented by `:memo:(README): Updated README with info`, I thought I can just add them to the custom_release_rules.
Unfortunately, as the separator `:` is hardcoded here
https://github.com/mathieudutour/github-tag-action/blob/87322e4efff34a7f630512379aabad45e3254d53/src/utils.ts#L76
it's not possible to add them like `:zap::patch, :bug::patch, :ambulance::patch, :sparkles::minor` etc..
My suggestion would be to either have optional separators with two new parameters (`:zap:,patch; :bug:,patch; ...`) or to use another data representation of the custom_release_rules.
What do you think @mathieudutour ?
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start in src/utils.ts at the linked line and trace how custom_release_rules are parsed and separated. Review the issue's gitmoji examples and decide how the configuration should represent separators; done means gitmoji rules can be configured without conflicting with the existing syntax.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- git, github-actions, typescript
- Domain
- ci-cd, release
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 32/100