Skip to content

Commit 5b82595

Browse files
authored
docs(readme): refresh badges and branch guidance (#58)
1 parent 624a9c8 commit 5b82595

6 files changed

Lines changed: 10 additions & 8 deletions

File tree

.github/workflows/ci.yml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,10 @@ name: CI
33
on:
44
pull_request:
55
branches:
6-
- master
76
- main
87
- beta
98
push:
109
branches:
11-
- master
1210
- main
1311
- beta
1412
workflow_dispatch:

.github/workflows/codeql-analysis.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,10 @@ name: "CodeQL"
1313

1414
on:
1515
push:
16-
branches: [ master, main ]
16+
branches: [ main ]
1717
pull_request:
1818
# The branches below must be a subset of the branches above
19-
branches: [ master, main ]
19+
branches: [ main ]
2020
schedule:
2121
- cron: '18 1 * * 0'
2222

.github/workflows/release.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@ name: Publish
33
on:
44
push:
55
branches:
6-
- master
76
- main
87
- beta
98

readme.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,21 @@
11
# semantic-release-npm-github-publish
22

3-
<p>
3+
<p align="center">
44
<a href="https://github.com/oleg-koval/semantic-release-npm-github-publish/actions/workflows/ci.yml" target="_blank">
55
<img alt="CI" src="https://github.com/oleg-koval/semantic-release-npm-github-publish/actions/workflows/ci.yml/badge.svg?branch=main">
66
</a>
77
<a href="https://github.com/oleg-koval/semantic-release-npm-github-publish/actions/workflows/release.yml" target="_blank">
88
<img alt="Publish" src="https://github.com/oleg-koval/semantic-release-npm-github-publish/actions/workflows/release.yml/badge.svg?branch=main">
99
</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>
1013
<a href="https://www.npmjs.com/package/semantic-release-npm-github-publish" target="_blank">
1114
<img alt="npm" src="https://img.shields.io/npm/v/semantic-release-npm-github-publish.svg">
1215
</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>
1319
<a href="https://github.com/oleg-koval/semantic-release-npm-github-publish/blob/main/LICENSE" target="_blank">
1420
<img alt="License: MIT" src="https://img.shields.io/badge/License-MIT-yellow.svg" />
1521
</a>
@@ -117,6 +123,7 @@ Use repo-local plugin composition instead when your team wants different plugins
117123

118124
- Consumer-facing examples now use `main`.
119125
- Repository automation publishes stable releases from `main` and prereleases from `beta`.
126+
- The repository default branch is `main`, and all badges and examples now follow that.
120127
- Dependabot PRs can auto-refresh `package-lock.json` through the dedicated lockfile-fixer workflow.
121128
- 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.
122129

release.repo.config.js

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@ const sharedConfig = require('./release.config');
33
module.exports = {
44
...sharedConfig,
55
branches: [
6-
{name: 'master', channel: 'latest'},
76
{name: 'main', channel: 'latest'},
87
{name: 'beta', prerelease: 'beta'},
98
],

test/release-config.test.js

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,6 @@ test('exports the documented plugin chain', () => {
4747
test('keeps beta prereleases as a repo-only branch policy', () => {
4848
assert.equal(releaseConfig.branches, undefined);
4949
assert.deepEqual(repoReleaseConfig.branches, [
50-
{name: 'master', channel: 'latest'},
5150
{name: 'main', channel: 'latest'},
5251
{name: 'beta', prerelease: 'beta'},
5352
]);

0 commit comments

Comments
 (0)