semantic-release / semantic-release/git

Semantic release tool is creating "git notes" is there documentation on why is that, and a way to disable this?

Open
#452 2 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

I have the following semantic-release configuration file:

{
  "branches": [
    "mainline",
    { name: "devel", prerelease: 'alpha'}
  ],
  "plugins": [
    "@semantic-release/commit-analyzer",
    "@semantic-release/release-notes-generator",
    "@semantic-release/changelog",
    ["@semantic-release/exec", {
      "prepareCmd": "echo '${nextRelease.version}' > version"
    }],
    ["@semantic-release/git", {
      "assets": ["CHANGELOG.md", "version"],
      "message": "chore(release): [KR-24] ${nextRelease.version}"
    }]
  ]
}

and I am seeing some commit related to "git notes" with a channel in it.

Notes added by 'git notes add'

{"channels":["devel"]}

etc...

I am not familiar with git notes but in our organization we do not really use those, how can I disable the creation of those? Or learn more about what is the purpose, etc.

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.

Research direction

Start with the semantic-release configuration and the reported git notes containing the devel channel, then trace which release behavior produces them. Document the purpose of these notes and whether their creation can be disabled; done means the behavior and supported configuration are clearly explained.

Written by the indexing model from the issue text.

Assessment

Tech stack
git, javascript
Domain
documentation, release
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.