semantic-release-npm-github-publish 1.7.2 → 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 +18 -0
package/package.json
CHANGED
package/readme.md
CHANGED
|
@@ -95,6 +95,11 @@ For this repository itself, stable releases come from `main` and prereleases com
|
|
|
95
95
|
|
|
96
96
|
## Usage
|
|
97
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
|
+
|
|
98
103
|
Example `.releaserc.yaml`:
|
|
99
104
|
|
|
100
105
|
```yaml
|
|
@@ -108,6 +113,17 @@ debug: false
|
|
|
108
113
|
|
|
109
114
|
If your repository releases from a different branch, set `branches` explicitly in your repo-local config.
|
|
110
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
|
+
|
|
111
127
|
## When To Use This Preset
|
|
112
128
|
|
|
113
129
|
Use this package when you want:
|
|
@@ -124,7 +140,9 @@ Use repo-local plugin composition instead when your team wants different plugins
|
|
|
124
140
|
- Consumer-facing examples now use `main`.
|
|
125
141
|
- Repository automation publishes stable releases from `main` and prereleases from `beta`.
|
|
126
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`.
|
|
127
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.
|
|
128
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.
|
|
129
147
|
|
|
130
148
|
## Contributing
|