semantic-release-npm-github-publish 1.7.1 → 1.7.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +1 -1
- package/readme.md +26 -1
package/package.json
CHANGED
package/readme.md
CHANGED
|
@@ -1,15 +1,21 @@
|
|
|
1
1
|
# semantic-release-npm-github-publish
|
|
2
2
|
|
|
3
|
-
<p>
|
|
3
|
+
<p align="center">
|
|
4
4
|
<a href="https://github.com/oleg-koval/semantic-release-npm-github-publish/actions/workflows/ci.yml" target="_blank">
|
|
5
5
|
<img alt="CI" src="https://github.com/oleg-koval/semantic-release-npm-github-publish/actions/workflows/ci.yml/badge.svg?branch=main">
|
|
6
6
|
</a>
|
|
7
7
|
<a href="https://github.com/oleg-koval/semantic-release-npm-github-publish/actions/workflows/release.yml" target="_blank">
|
|
8
8
|
<img alt="Publish" src="https://github.com/oleg-koval/semantic-release-npm-github-publish/actions/workflows/release.yml/badge.svg?branch=main">
|
|
9
9
|
</a>
|
|
10
|
+
<a href="https://github.com/oleg-koval/semantic-release-npm-github-publish/actions/workflows/codeql-analysis.yml" target="_blank">
|
|
11
|
+
<img alt="CodeQL" src="https://github.com/oleg-koval/semantic-release-npm-github-publish/actions/workflows/codeql-analysis.yml/badge.svg?branch=main">
|
|
12
|
+
</a>
|
|
10
13
|
<a href="https://www.npmjs.com/package/semantic-release-npm-github-publish" target="_blank">
|
|
11
14
|
<img alt="npm" src="https://img.shields.io/npm/v/semantic-release-npm-github-publish.svg">
|
|
12
15
|
</a>
|
|
16
|
+
<a href="https://www.npmjs.com/package/semantic-release-npm-github-publish" target="_blank">
|
|
17
|
+
<img alt="npm downloads" src="https://img.shields.io/npm/dm/semantic-release-npm-github-publish.svg">
|
|
18
|
+
</a>
|
|
13
19
|
<a href="https://github.com/oleg-koval/semantic-release-npm-github-publish/blob/main/LICENSE" target="_blank">
|
|
14
20
|
<img alt="License: MIT" src="https://img.shields.io/badge/License-MIT-yellow.svg" />
|
|
15
21
|
</a>
|
|
@@ -89,6 +95,11 @@ For this repository itself, stable releases come from `main` and prereleases com
|
|
|
89
95
|
|
|
90
96
|
## Usage
|
|
91
97
|
|
|
98
|
+
<p>
|
|
99
|
+
<strong style="color:#b91c1c;">Migration notice:</strong>
|
|
100
|
+
this preset does not hardcode consumer release branches. `main` is the documented default, but if your repository still releases from `master` or another branch, set `branches` explicitly in your repo-local semantic-release config.
|
|
101
|
+
</p>
|
|
102
|
+
|
|
92
103
|
Example `.releaserc.yaml`:
|
|
93
104
|
|
|
94
105
|
```yaml
|
|
@@ -102,6 +113,17 @@ debug: false
|
|
|
102
113
|
|
|
103
114
|
If your repository releases from a different branch, set `branches` explicitly in your repo-local config.
|
|
104
115
|
|
|
116
|
+
Example migration from `master`:
|
|
117
|
+
|
|
118
|
+
```yaml
|
|
119
|
+
branches:
|
|
120
|
+
- master
|
|
121
|
+
extends: "semantic-release-npm-github-publish"
|
|
122
|
+
ci: false
|
|
123
|
+
dryRun: false
|
|
124
|
+
debug: false
|
|
125
|
+
```
|
|
126
|
+
|
|
105
127
|
## When To Use This Preset
|
|
106
128
|
|
|
107
129
|
Use this package when you want:
|
|
@@ -117,7 +139,10 @@ Use repo-local plugin composition instead when your team wants different plugins
|
|
|
117
139
|
|
|
118
140
|
- Consumer-facing examples now use `main`.
|
|
119
141
|
- Repository automation publishes stable releases from `main` and prereleases from `beta`.
|
|
142
|
+
- The repository default branch is `main`, and all badges and examples now follow that.
|
|
143
|
+
- The shared preset does not hardcode release branches for consumers; set `branches` in your repo-local config when you do not release from `main`.
|
|
120
144
|
- Dependabot PRs can auto-refresh `package-lock.json` through the dedicated lockfile-fixer workflow.
|
|
145
|
+
- Dependabot npm patch updates can enable GitHub auto-merge after required checks pass.
|
|
121
146
|
- The old README wording that inverted `fix` and `feat` was documentation drift. The actual release behavior has been corrected and is now covered by tests.
|
|
122
147
|
|
|
123
148
|
## Contributing
|