Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

branch variable does not match documentation #428

Open
hanseltime opened this issue Mar 15, 2023 · 0 comments
Open

branch variable does not match documentation #428

hanseltime opened this issue Mar 15, 2023 · 0 comments

Comments

@hanseltime
Copy link

So I recently came across an issue where my commit message couldn't actually include "branch.name".

Upon further investigation, I found this section of the prepare code:

? template(message)({branch: branch.name, lastRelease, nextRelease})

    await commit(
      message
        ? template(message)({branch: branch.name, lastRelease, nextRelease})
        : `chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}`,
      {env, cwd}
    );

It looks like we've historically been adding branch as just the branch name. Before I submit a PR, it seems there are two ways that this can go:

  1. change the README to say that only "branch" is available for the message as the branch name
  2. make branch the object intended with some sort of backwards compatibility for any semantic-release versions (or just make it a major version bump)

I wanted to report this as an issue before trying to submit a PR that makes the opinion.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant