Skip to content

Commit 7ba2397

Browse files
committed
doc: fixed template marks in maintainers doc
Signed-off-by: Frederic BIDON <fredbi@yahoo.com>
1 parent 9f28936 commit 7ba2397

File tree

1 file changed

+13
-11
lines changed

1 file changed

+13
-11
lines changed

docs/MAINTAINERS.md

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Single go module.
66

77
> **NOTE**
88
>
9-
> Some `{{ .Owner }}` repos are mono-repos with multiple modules,
9+
> Some `go-openapi` repos are mono-repos with multiple modules,
1010
> with adapted CI workflows.
1111
1212
## Repo configuration
@@ -37,16 +37,16 @@ Single go module.
3737
>
3838
> codefactor inherits roles from github. There is no need to create a dedicated account.
3939
>
40-
> The codefactor app is installed at the organization level (`github.com/{{ .Owner }}`).
40+
> The codefactor app is installed at the organization level (`github.com/go-openapi`).
4141
>
4242
> There is no special token to setup in github for CI usage.
4343
4444
### Testing
4545

4646
* Test reports
47-
* Uploaded to codecov: <https://app.codecov.io/analytics/gh/{{ .Owner }}>
47+
* Uploaded to codecov: <https://app.codecov.io/analytics/gh/go-openapi>
4848
* Test coverage reports
49-
* Uploaded to codecov: <https://app.codecov.io/gh/{{ .Owner }}>
49+
* Uploaded to codecov: <https://app.codecov.io/gh/go-openapi>
5050

5151
* Fuzz testing
5252
* Fuzz tests are handled separately by CI and may reuse a cached version of the fuzzing corpus.
@@ -58,7 +58,7 @@ Coverage threshold status is informative and not blocking.
5858
This is because the thresholds are difficult to tune and codecov oftentimes reports false negatives
5959
or may fail to upload coverage.
6060

61-
All tests use our fork of `stretchr/testify`: `github.com/{{ .Owner }}/testify`.
61+
All tests use our fork of `stretchr/testify`: `github.com/go-openapi/testify`.
6262
This allows for minimal test dependencies.
6363

6464
> **NOTES**
@@ -67,7 +67,7 @@ This allows for minimal test dependencies.
6767
> However, there is only 1 maintainer allowed to be the admin of the organization on codecov
6868
> with their free plan.
6969
>
70-
> The codecov app is installed at the organization level (`github.com/{{ .Owner }}`).
70+
> The codecov app is installed at the organization level (`github.com/go-openapi`).
7171
>
7272
> There is no special token to setup in github for CI usage.
7373
> A organization-level token used to upload coverage and test reports is managed at codecov:
@@ -81,7 +81,7 @@ This allows for minimal test dependencies.
8181
Principle:
8282

8383
* codecov applies updates and security patches to the github-actions and golang ecosystems.
84-
* all updates from "trusted" dependencies (github actions, golang.org packages, {{ .Owner }} packages
84+
* all updates from "trusted" dependencies (github actions, golang.org packages, go-openapi packages
8585
are auto-merged if they successfully pass CI.
8686

8787
* go version udpates
@@ -138,20 +138,22 @@ Standard documentation:
138138
* [`CODE_OF_CONDUCT.md`](../CODE_OF_CONDUCT.md)
139139
* [`SECURIY.md`](../SECURITY.md) policy: how to report vulnerabilities privately
140140
* [`LICENSE`](../LICENSE) terms
141+
<!--
141142
* [`NOTICE`](../NOTICE) on supplementary license terms (original authors, copied code etc)
143+
-->
142144

143145
Reference documentation (released):
144146

145-
* [godoc](https://pkg.go/dev/{{ .Owner }}/{{ .Repo }})
147+
* [godoc](https://pkg.go/dev/go-openapi/analysis)
146148

147149
## TODOs & other ideas
148150

149151
A few things remain ahead to ease a bit a maintainer's job:
150152

151-
* [ ] reuse CI workflows (e.g. in `github.com/{{ .Owner }}/workflows`)
152-
* [ ] reusable actions with custom tools pinned (e.g. in `github.com/{{ .Owner }}/gh-actions`)
153+
* [x] reuse CI workflows (e.g. in `github.com/go-openapi/workflows`)
154+
* [x] reusable actions with custom tools pinned (e.g. in `github.com/go-openapi/gh-actions`)
153155
* [ ] open-source license checks
154-
* [ ] auto-merge for CONTRIBUTORS.md (requires a github app to produce tokens)
156+
* [x] auto-merge for CONTRIBUTORS.md (requires a github app to produce tokens)
155157
* [ ] more automated code renovation / relinting work (possibly built with CLAUDE)
156158
* [ ] organization-level documentation web site
157159
* ...

0 commit comments

Comments
 (0)