bug: message format template does not receive documented variables

Open
#212 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
35/100
Issue type
Bug
Clarity
Mostly clear
Activity status
Stale
Tech stack
git, javascript
Domain
release

Research direction

Start at lib/prepare.js#L65 and compare its message-template inputs with the variables documented at the linked semantic-release/git message page. Trace how branch is assigned and determine the compatibility constraints; done means documented variables such as branch.type are available without breaking current behavior, with the resulting behavior reflected in documentation.

Written by the indexing model from the issue text.

Description

according to https://github.com/semantic-release/git#message

multiple variables are available, eg. branch.type (what i desperatly need), but this seems to have been broken.

in https://github.com/semantic-release/git/blob/master/lib/prepare.js#L65

its clear that these variables are not available. Worse: branch has been overwritten with branch.name. So without breaking, we cannot re-introduce the branch variable to access branch.type etc. On the other hand, the current behaviour is not documented and therefore might not be intended

Dominant language
JavaScript
Stars
339
Forks
75
Avg merge
5h 15m
Merged PRs (30d)
6

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.

More from semantic-release/git

All issues in semantic-release/git

Similar issues

More JavaScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.