Skip to content

Commit 23e908b

Browse files
Remove coveralls leftovers, make GitHub Actions config examples less confusing
1 parent ed96042 commit 23e908b

File tree

2 files changed

+28
-30
lines changed

2 files changed

+28
-30
lines changed

README.md

Lines changed: 28 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -402,7 +402,7 @@ customManagers:
402402

403403
```yaml
404404
reuse:
405-
enabled: false
405+
enabled: true
406406
annotations:
407407
- paths:
408408
- internal/**/fixtures/*.json
@@ -574,26 +574,23 @@ This workflow:
574574
* checks your code using `golangci-lint`
575575
* ensures that your code compiles successfully
576576
* runs tests and generates test coverage report
577-
* uploads the test coverage report to [Coveralls]
578577

579578
```yaml
580-
ci:
581-
enabled: true
582-
runOn:
583-
- macos-latest
584-
- ubuntu-latest
585-
- windows-latest
586-
coveralls: true
587-
prepareMakeTarget: generate
588-
ignorePaths: []
579+
githubWorkflow:
580+
ci:
581+
enabled: true
582+
runOn:
583+
- macos-latest
584+
- ubuntu-latest
585+
- windows-latest
586+
prepareMakeTarget: generate
587+
ignorePaths: []
589588
```
590589

591590
`runOn` specifies a list of machine(s) to run the `build` and `test` jobs on ([more info][ref-runs-on]).
592591
You can use this to ensure that your build compilation and tests are
593592
successful on multiple operating systems. Default value for this is `ubuntu-latest`.
594593

595-
If `coveralls` is `true` then your test coverage report will be uploaded to [Coveralls]. Make sure that you have enabled Coveralls for your GitHub repo beforehand.
596-
597594
`ignorePaths` specifies a list of filename patterns. Workflows will not trigger if a path
598595
name matches a pattern in this list. [More info][ref-onpushpull] and [filter pattern cheat
599596
sheet][ref-pattern-cheat-sheet]. This option is not defined by default.
@@ -610,14 +607,15 @@ This is intended for use with `github.com/sapcc/go-bits/easypg`, which can launc
610607
If `enabled` is set to true, the generated `Dockerfile` is built for the platforms `linux/amd64` and `linux/arm64` and pushed to the repository path under `ghcr.io`.
611608

612609
```yaml
613-
pushContainerToGhcr:
614-
enabled: true
615-
platforms: "linux/amd64,linux/arm64"
616-
tagStrategy:
617-
- edge
618-
- latest
619-
- semver
620-
- sha
610+
githubWorkflow:
611+
pushContainerToGhcr:
612+
enabled: true
613+
platforms: "linux/amd64,linux/arm64"
614+
tagStrategy:
615+
- edge
616+
- latest
617+
- semver
618+
- sha
621619
```
622620

623621
`platforms` configures for which platforms the multi-arch docker image is built. Defaults to `linux/amd64`. Note: emulation is provided by qemu and might take significant time.
@@ -650,9 +648,10 @@ If `securityChecks` is enabled then it will generate the following workflows:
650648
It uses the [Go Vulnerability Database](https://pkg.go.dev/vuln/) as a source.
651649

652650
```yaml
653-
securityChecks:
654-
enabled: true
655-
queries: security-extended
651+
githubWorkflow:
652+
securityChecks:
653+
enabled: true
654+
queries: security-extended
656655
```
657656

658657
`queries` is passed through to the GitHub Action. See the [GitHub Documentation](https://docs.github.com/en/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/customizing-your-advanced-setup-for-code-scanning#working-with-custom-configuration-files) for more information.
@@ -663,10 +662,11 @@ This workflow uses [`addlicense`][addlicense] to ensure that all your Go source
663662
If vendoring is enabled, the `vendor/` directory is always entirely ignored by this workflow.
664663

665664
```yaml
666-
license:
667-
enabled: true
668-
ignorePatterns:
669-
- "vendor/**"
665+
githubWorkflow:
666+
license:
667+
enabled: true
668+
ignorePatterns:
669+
- "vendor/**"
670670
```
671671

672672
`ignorePatterns` specifies a list of file patterns to check. You can use any pattern
@@ -675,7 +675,6 @@ license:
675675
**Hint**: You can also use `addlicense` to add license headers to all unignored Go files by running `make license-headers`. The copyright text used is customizable by setting `license.copyright` in the `Makefile.maker.yaml` file.
676676

677677
[codeql]: https://codeql.github.com/
678-
[coveralls]: https://coveralls.io
679678
[doublestar-pattern]: https://github.com/bmatcuk/doublestar#patterns
680679
[go-licence-detector]: https://github.com/elastic/go-licence-detector
681680
[govulncheck]: https://github.com/golang/vuln

internal/core/config.go

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -156,7 +156,6 @@ type GithubWorkflowConfiguration struct {
156156
// CIWorkflowConfig appears in type Configuration.
157157
type CIWorkflowConfig struct {
158158
Enabled bool `yaml:"enabled"`
159-
Coveralls bool `yaml:"coveralls"`
160159
PrepareMakeTarget string `yaml:"prepareMakeTarget"`
161160
IgnorePaths []string `yaml:"ignorePaths"`
162161
RunsOn []string `yaml:"runOn"`

0 commit comments

Comments
 (0)