Skip to content

Commit 29839bd

Browse files
travigr2m
andauthored
docs(release-commits): add warning about considering if the plugin is truly needed for a project (#513)
* docs(release-commits): add warning about considering if the plugin is truly needed for a project * Update README.md --------- Co-authored-by: Gregor Martynus <[email protected]>
1 parent 8ad065b commit 29839bd

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

README.md

+4
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22

33
[**semantic-release**](https://github.com/semantic-release/semantic-release) plugin to commit release assets to the project's [git](https://git-scm.com/) repository.
44

5+
> [!WARNING]
6+
> You likely _do not_ need this plugin to accomplish your goals with semantic-release.
7+
> Please consider our [recommendation against making commits during your release](https://semantic-release.gitbook.io/semantic-release/support/faq#making-commits-during-the-release-process-adds-significant-complexity) to avoid unnecessary headaches.
8+
59
[![Build Status](https://github.com/semantic-release/git/workflows/Test/badge.svg)](https://github.com/semantic-release/git/actions?query=workflow%3ATest+branch%3Amaster) [![npm latest version](https://img.shields.io/npm/v/@semantic-release/git/latest.svg)](https://www.npmjs.com/package/@semantic-release/git)
610
[![npm next version](https://img.shields.io/npm/v/@semantic-release/git/next.svg)](https://www.npmjs.com/package/@semantic-release/git)
711
[![npm beta version](https://img.shields.io/npm/v/@semantic-release/git/beta.svg)](https://www.npmjs.com/package/@semantic-release/git)

0 commit comments

Comments
 (0)