Troubleshooting
Last updated
Last updated
When running semantic-release you might encounter the following error:
This is most likely related to a misconfiguration of the or to your user for publishing.
It might also happen if the package name you are trying to publish already exists (in the case of npm, you may be trying to publish a new version of a package that is not yours, hence the permission error).
To verify if your package name is available you can use :
If the package name is not available, change it in your package.json
or consider using an .
semantic-release parses commits according to a to figure out how they affect the codebase. Commits that doesn't follow the project's commit message convention are simply ignored.
When most Git tools will by default generate a new commit message with a summary of the squashed commits. This commit message will most likely not be compliant with the project's commit message convention and therefore will be ignored by semantic-release.
When squashing commits make sure to rewrite the resulting commit message to be compliant with the project's commit message convention.
Note: if the resulting squashed commit would encompasses multiple changes (for example multiple unrelated features or fixes) then it's probably not a good idea to squash those commits together. A commit should contain exactly one self-contained functional change and a functional change should be contained in exactly one commit. See .
reference already exists
error when pushing tagIf an actual release with that version number was published you need to merge all the commits up to that release into your release branch.
If there is no published release with that version number, the tag must be deleted.
git push --force
After a git history rewrite due to a git push --force
, the git tags and notes referencing the commits that were rewritten are lost.
To recover from that situation, do the following:
Delete the tag(s) for the release(s) that have been lost from the git history. You can delete each tag from remote using git push origin :[TAG NAME]
, e.g. git push origin :v2.0.0-beta.1
. You can delete tags locally using git tag -d [TAG NAME]
, e.g. git tag -d v2.0.0-beta.1
.
Re-create the tags locally: git tag [TAG NAME] [COMMIT HASH]
, where [COMMIT HASH]
is the new commit that created the release for the lost tag. E.g. git tag v2.0.0-beta.1 abcdef0
Re-create the git notes for each release tag, e.g. git notes --ref semantic-release add -f -m '{"channels":["beta"]}' v2.0.0-beta.1
. If the release was also published in the default channel (usually master
), then set the first channel to null
, e.g. `git notes --ref semantic-release add -f -m '{"channels":[null, "beta"]}'
Push the local notes: git push --force origin refs/notes/semantic-release
. The --force
is needed after the rebase. Be careful.
semantic-release read that are present in the history of your release branch in order to determine the last release published. Then it determines the next version to release based on the commits pushed since then and create the corresponding tag. If a tag with the name already in your repository, Git will throw and error as tags must be unique across the repository. This situation happens when you have a version tag identical to the new one semantic-release is trying to create that is not in the history of the current branch.
semantic-release is using both and to store information about which releases happened in which branch.