Skip to content

Commit 3169b2e

Browse files
committed
wrapped up working vs experimental
Signed-off-by: Frederic BIDON <fredbi@yahoo.com>
1 parent f1e06c9 commit 3169b2e

5 files changed

Lines changed: 47 additions & 26 deletions

File tree

README.md

Lines changed: 20 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,7 @@
88
[![Release][release-badge]][release-url] [![Go Report Card][gocard-badge]][gocard-url] [![CodeFactor Grade][codefactor-badge]][codefactor-url] [![License][license-badge]][license-url]
99
<!-- Badges: documentation & support -->
1010
<!-- Badges: others & stats -->
11-
<!-- Slack badge disabled until I am able to restore a valid link to the chat -->
12-
[![GoDoc][godoc-badge]][godoc-url] <!-- [![Slack Channel][slack-badge]][slack-url] -->[![go version][goversion-badge]][goversion-url] ![Top language][top-badge] ![Commits since latest release][commits-badge]
11+
[![GoDoc][godoc-badge]][godoc-url] [![Slack Channel][slack-logo]![slack-badge]][slack-url] [![go version][goversion-badge]][goversion-url] ![Top language][top-badge] ![Commits since latest release][commits-badge]
1312

1413
---
1514

@@ -36,18 +35,16 @@ It took a while (well a something like 10 years...), but we eventually managed t
3635
dependabot rules declared in the family of go-openapi repos.
3736

3837
Now we'd like to be able to maintain, enrich and improve these checks without
39-
worrying too much about the burden of replicating it about a dozen times.
38+
worrying too much about the burden of replicating the stuff about a dozen times.
4039

4140
## Contemplated enhancements
4241

4342
In no particular order:
4443

4544
* [x] ui: enrich github actions UI with a job summary
46-
* [x] doc: add markdown linting for docs
47-
* [x] doc: add spellcheck for docs (and code?)
4845
* [x] introduce config file specific checkout (markdownlint, spellcheck)
4946
* [x] security: separate PR / issue comments as a trusted bot workflow, acting on request artifacts
50-
* [ ] version common workflows, so we can limit the impact of a change
47+
* [x] version common workflows, so we can limit the impact of a change
5148
* [ ] build: verify that go.sum cache for tests works (should be enabled)
5249
* [ ] share mono repo workflows (see github.com/go-openapi/swag/.github/workflows)
5350
* [ ] lint: manage somehow to share golangci config (with local merge)
@@ -64,11 +61,15 @@ In no particular order:
6461
are identical
6562
* [ ] comment PRs and issues
6663
* [ ] doc: checkout vale style-check guide (vale-action exists)
67-
* [ ] doc: experiment LanguageTool for grammar checks ( -> a github action / docker image exists)
64+
* [x] ~doc: experiment LanguageTool for grammar checks ( -> a github action / docker image exists)~
6865
* [ ] doc: experiment LLM from github model, using embeddings ( ->
6966
* [ ] issues: experiment LLM from github model, using embeddings ( -> show related issues)
7067
* [ ] github pages w/ hugo (like go-swagger, experiment another theme and json data)
7168

69+
To be reworked:
70+
* [ ] doc: add markdown linting for docs
71+
* [ ] doc: add spellcheck for docs (and code?)
72+
7273
## Change log
7374

7475
See <https://github.com/go-openapi/ci-workflows/releases>
@@ -88,6 +89,15 @@ This content ships under the [SPDX-License-Identifier: Apache-2.0](./LICENSE).
8889
* [Maintainers documentation](docs/MAINTAINERS.md)
8990
* [Code style](docs/STYLE.md)
9091

92+
## Cutting a new release
93+
94+
Maintainers can cut a new release by either:
95+
96+
* running [this workflow](https://github.com/go-openapi/gh-actions/actions/workflows/local-bump-release.yml)
97+
* or pushing a semver tag
98+
* signed tags are preferred
99+
* The tag message is prepended to release notes
100+
91101
<!-- Badges: status -->
92102
[test-badge]: https://github.com/go-openapi/ci-workflows/actions/workflows/go-test.yml/badge.svg
93103
[test-url]: https://github.com/go-openapi/ci-workflows/actions/workflows/go-test.yml
@@ -112,8 +122,9 @@ This content ships under the [SPDX-License-Identifier: Apache-2.0](./LICENSE).
112122
[doc-url]: https://goswagger.io/go-openapi
113123
[godoc-badge]: https://pkg.go.dev/badge/github.com/go-openapi/ci-workflows
114124
[godoc-url]: http://pkg.go.dev/github.com/go-openapi/ci-workflows
115-
[slack-badge]: https://slackin.goswagger.io/badge.svg
116-
[slack-url]: https://slackin.goswagger.io
125+
[slack-logo]: https://a.slack-edge.com/e6a93c1/img/icons/favicon-32.png
126+
[slack-badge]: https://img.shields.io/badge/slack-blue?link=https%3A%2F%2Fgoswagger.slack.com%2Farchives%2FC04R30YM
127+
[slack-url]: https://goswagger.slack.com/archives/C04R30YMU
117128
<!-- Badges: license & compliance -->
118129
[license-badge]: http://img.shields.io/badge/license-Apache%20v2-orange.svg
119130
[license-url]: https://github.com/go-openapi/ci-workflows/?tab=Apache-2.0-1-ov-file#readme

doc-templates/README.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,7 @@
88
[![Release][release-badge]][release-url] [![Go Report Card][gocard-badge]][gocard-url] [![CodeFactor Grade][codefactor-badge]][codefactor-url] [![License][license-badge]][license-url]
99
<!-- Badges: documentation & support -->
1010
<!-- Badges: others & stats -->
11-
<!-- Slack badge disabled until I am able to restore a valid link to the chat -->
12-
[![GoDoc][godoc-badge]][godoc-url] <!-- [![Slack Channel][slack-badge]][slack-url] -->[![go version][goversion-badge]][goversion-url] ![Top language][top-badge] ![Commits since latest release][commits-badge]
11+
[![GoDoc][godoc-badge]][godoc-url] [![Slack Channel][slack-logo]![slack-badge]][slack-url] [![go version][goversion-badge]][goversion-url] ![Top language][top-badge] ![Commits since latest release][commits-badge]
1312

1413
---
1514

@@ -55,6 +54,15 @@ on top of which it has been built.
5554
* [Maintainers documentation](docs/MAINTAINERS.md)
5655
* [Code style](docs/STYLE.md)
5756

57+
## Cutting a new release
58+
59+
Maintainers can cut a new release by either:
60+
61+
* running [this workflow](https://github.com/{{ .Owner }}/{{ .Repo }}/actions/workflows/bump-release.yml)
62+
* or pushing a semver tag
63+
* signed tags are preferred
64+
* The tag message is prepended to release notes
65+
5866
<!-- Badges: status -->
5967
[test-badge]: https://github.com/{{ .Owner }}/{{ .Repo }}/actions/workflows/go-test.yml/badge.svg
6068
[test-url]: https://github.com/{{ .Owner }}/{{ .Repo }}/actions/workflows/go-test.yml

experimental/go-test-monorepo.yml

Lines changed: 17 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -44,23 +44,24 @@ jobs:
4444
with:
4545
version: latest
4646
skip-cache: true
47-
install-only: true
48-
-
49-
name: Lint multiple modules
50-
if: ${{ steps.detect-monorepo.outputs == 'true' }}
51-
# golangci-lint doesn't support go.work to lint multiple modules in one single pass
52-
# TODO: golangci-action v9.1+ has a built-in mono repo detection setup.
53-
run: |
54-
set -euxo pipefail
47+
#install-only: true
48+
experimental: "automatic-module-directories"
49+
#-
50+
# name: Lint multiple modules
51+
# if: ${{ steps.detect-monorepo.outputs == 'true' }}
52+
# # golangci-lint doesn't support go.work to lint multiple modules in one single pass
53+
# # TODO: golangci-action v9.1+ has a built-in mono repo detection setup.
54+
# run: |
55+
# set -euxo pipefail
5556

56-
git fetch origin master
57-
git show --no-patch --oneline origin/master
57+
# git fetch origin master
58+
# git show --no-patch --oneline origin/master
5859

59-
while read -r module_location ; do
60-
pushd "${module_location}"
61-
golangci-lint run --new-from-rev origin/master
62-
popd
63-
done < <(go list -f '{{.Dir}}' -m)
60+
# while read -r module_location ; do
61+
# pushd "${module_location}"
62+
# golangci-lint run --new-from-rev origin/master
63+
# popd
64+
# done < <(go list -f '{{.Dir}}' -m)
6465

6566
test:
6667
name: Unit tests mono-repo
@@ -162,6 +163,7 @@ jobs:
162163
retention-days: 1
163164

164165
fuzz-test:
166+
# fuzz-test supports go monorepos
165167
uses: ./.github/workflows/fuzz-test.yml
166168

167169
test-complete:

0 commit comments

Comments
 (0)