Skip to content

Commit a643619

Browse files
committed
fix: Correct branch references from main to master
The default branch is still master, but several files referenced main, causing docs deployment and coverage badge pushing to silently fail. Fixed references in: - CONTRIBUTING.md: branch instructions - docs/contributing.md: branch instructions - docs/index.md: coverage badge URL, LICENSE link - README.md: coverage badge URL - .github/workflows/test.yml: git-token condition - .github/workflows/docs.yml: branch trigger
1 parent 0e228d0 commit a643619

File tree

6 files changed

+9
-9
lines changed

6 files changed

+9
-9
lines changed

.github/workflows/docs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ name: Docs
22

33
on:
44
push:
5-
branches: [main]
5+
branches: [master]
66
paths:
77
- 'docs/**'
88
- 'mkdocs.yml'

.github/workflows/test.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ jobs:
4545
with:
4646
config: ./.testcoverage.yml
4747
profile: coverage.out
48-
git-token: ${{ github.ref_name == 'main' && secrets.GITHUB_TOKEN || '' }}
48+
git-token: ${{ github.ref_name == 'master' && secrets.GITHUB_TOKEN || '' }}
4949
git-branch: badges
5050

5151
coverage-report:

CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,11 @@ go test ./...
1717

1818
cisshgo uses [GitHub Flow](https://docs.github.com/en/get-started/using-github/github-flow):
1919

20-
1. Fork the repo and create a branch from `main`
20+
1. Fork the repo and create a branch from `master`
2121
2. Make your changes
2222
3. Ensure tests pass and coverage stays above 90%: `go test -race -coverprofile=coverage.out ./...`
2323
4. Ensure code is formatted: `gofmt -w ./...`
24-
5. Open a pull request against `main`
24+
5. Open a pull request against `master`
2525

2626
Branch naming convention:
2727
- `feat/short-description` — new features

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Simple, small, fast, concurrent SSH server to emulate network equipment (i.e. Cisco IOS) for testing purposes.
44

55
[![CI](https://github.com/tbotnz/cisshgo/actions/workflows/test.yml/badge.svg)](https://github.com/tbotnz/cisshgo/actions/workflows/test.yml)
6-
[![coverage](https://raw.githubusercontent.com/tbotnz/cisshgo/badges/.badges/main/coverage.svg)](https://github.com/tbotnz/cisshgo/actions/workflows/test.yml)
6+
[![coverage](https://raw.githubusercontent.com/tbotnz/cisshgo/badges/.badges/master/coverage.svg)](https://github.com/tbotnz/cisshgo/actions/workflows/test.yml)
77
[![Go Report Card](https://goreportcard.com/badge/github.com/tbotnz/cisshgo)](https://goreportcard.com/report/github.com/tbotnz/cisshgo)
88
[![Go Reference](https://pkg.go.dev/badge/github.com/tbotnz/cisshgo.svg)](https://pkg.go.dev/github.com/tbotnz/cisshgo)
99
[![Release](https://img.shields.io/github/v/release/tbotnz/cisshgo)](https://github.com/tbotnz/cisshgo/releases)

docs/contributing.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,11 @@ go test ./...
1717

1818
cisshgo uses [GitHub Flow](https://docs.github.com/en/get-started/using-github/github-flow):
1919

20-
1. Fork the repo and create a branch from `main`
20+
1. Fork the repo and create a branch from `master`
2121
2. Make your changes
2222
3. Ensure tests pass and coverage stays above 90%
2323
4. Ensure code is formatted with `gofmt`
24-
5. Open a pull request against `main`
24+
5. Open a pull request against `master`
2525

2626
### Branch Naming
2727

docs/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,12 +43,12 @@ Cisco IOS XE Software, Version 16.04.01
4343
## Project Status
4444

4545
[![CI](https://github.com/tbotnz/cisshgo/actions/workflows/test.yml/badge.svg)](https://github.com/tbotnz/cisshgo/actions/workflows/test.yml)
46-
[![coverage](https://raw.githubusercontent.com/tbotnz/cisshgo/badges/.badges/main/coverage.svg)](https://github.com/tbotnz/cisshgo/actions/workflows/test.yml)
46+
[![coverage](https://raw.githubusercontent.com/tbotnz/cisshgo/badges/.badges/master/coverage.svg)](https://github.com/tbotnz/cisshgo/actions/workflows/test.yml)
4747
[![Go Report Card](https://goreportcard.com/badge/github.com/tbotnz/cisshgo)](https://goreportcard.com/report/github.com/tbotnz/cisshgo)
4848

4949
## License
5050

51-
MIT License - see [LICENSE](https://github.com/tbotnz/cisshgo/blob/main/LICENSE) file for details.
51+
MIT License - see [LICENSE](https://github.com/tbotnz/cisshgo/blob/master/LICENSE) file for details.
5252

5353
## Disclaimer
5454

0 commit comments

Comments
 (0)