You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+28-29Lines changed: 28 additions & 29 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -402,7 +402,7 @@ customManagers:
402
402
403
403
```yaml
404
404
reuse:
405
-
enabled: false
405
+
enabled: true
406
406
annotations:
407
407
- paths:
408
408
- internal/**/fixtures/*.json
@@ -574,26 +574,23 @@ This workflow:
574
574
* checks your code using `golangci-lint`
575
575
* ensures that your code compiles successfully
576
576
* runs tests and generates test coverage report
577
-
* uploads the test coverage report to [Coveralls]
578
577
579
578
```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: []
589
588
```
590
589
591
590
`runOn`specifies a list of machine(s) to run the `build` and `test` jobs on ([more info][ref-runs-on]).
592
591
You can use this to ensure that your build compilation and tests are
593
592
successful on multiple operating systems. Default value for this is `ubuntu-latest`.
594
593
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
-
597
594
`ignorePaths`specifies a list of filename patterns. Workflows will not trigger if a path
598
595
name matches a pattern in this list. [More info][ref-onpushpull] and [filter pattern cheat
599
596
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
610
607
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`.
611
608
612
609
```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
621
619
```
622
620
623
621
`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:
650
648
It uses the [Go Vulnerability Database](https://pkg.go.dev/vuln/) as a source.
651
649
652
650
```yaml
653
-
securityChecks:
654
-
enabled: true
655
-
queries: security-extended
651
+
githubWorkflow:
652
+
securityChecks:
653
+
enabled: true
654
+
queries: security-extended
656
655
```
657
656
658
657
`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
663
662
If vendoring is enabled, the `vendor/` directory is always entirely ignored by this workflow.
664
663
665
664
```yaml
666
-
license:
667
-
enabled: true
668
-
ignorePatterns:
669
-
- "vendor/**"
665
+
githubWorkflow:
666
+
license:
667
+
enabled: true
668
+
ignorePatterns:
669
+
- "vendor/**"
670
670
```
671
671
672
672
`ignorePatterns`specifies a list of file patterns to check. You can use any pattern
@@ -675,7 +675,6 @@ license:
675
675
**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.
0 commit comments