From d2fda3859c3f43f86dfa0a061f743aaf4fe4ea3c Mon Sep 17 00:00:00 2001 From: Wei Fu Date: Sun, 8 Oct 2023 15:12:35 +0800 Subject: [PATCH] *: enable markdown_marker checker Signed-off-by: Wei Fu --- .github/workflows/static-analysis.yaml | 7 +++++++ Documentation/contributor-guide/branch_management.md | 4 ++-- Documentation/contributor-guide/community-membership.md | 6 +++--- Makefile | 6 +++++- 4 files changed, 17 insertions(+), 6 deletions(-) diff --git a/.github/workflows/static-analysis.yaml b/.github/workflows/static-analysis.yaml index a7ee8d6aa031..11934dbef194 100644 --- a/.github/workflows/static-analysis.yaml +++ b/.github/workflows/static-analysis.yaml @@ -22,6 +22,13 @@ jobs: with: version: '3.20.3' repo-token: ${{ secrets.GITHUB_TOKEN }} + - uses: actions-rs/toolchain@v1 + with: + toolchain: stable + - run: | + set -euo pipefail + + cargo install --git https://github.com/fuweid/marker.git --branch support-absolute-path - run: | set -euo pipefail diff --git a/Documentation/contributor-guide/branch_management.md b/Documentation/contributor-guide/branch_management.md index 838a08c72132..1b92033ed706 100644 --- a/Documentation/contributor-guide/branch_management.md +++ b/Documentation/contributor-guide/branch_management.md @@ -15,13 +15,13 @@ The `main` branch is our development branch. All new features land here first. To try new and experimental features, pull `main` and play with it. Note that `main` may not be stable because new features may introduce bugs. -Before the release of the next stable version, feature PRs will be frozen. A [release manager](./release.md/#release-management) will be assigned to major/minor version and will lead the etcd community in test, bug-fix and documentation of the release for one to two weeks. +Before the release of the next stable version, feature PRs will be frozen. A [release manager](./release.md#release-management) will be assigned to major/minor version and will lead the etcd community in test, bug-fix and documentation of the release for one to two weeks. ### Stable branches All branches with prefix `release-` are considered _stable_ branches. -After every minor release ([semver.org](https://semver.org/)), we will have a new stable branch for that release, managed by a [patch release manager](./release.md/#release-management). We will keep fixing the backwards-compatible bugs for the latest two stable releases. A _patch_ release to each supported release branch, incorporating any bug fixes, will be once every two weeks, given any patches. +After every minor release ([semver.org](https://semver.org/)), we will have a new stable branch for that release, managed by a [patch release manager](./release.md#release-management). We will keep fixing the backwards-compatible bugs for the latest two stable releases. A _patch_ release to each supported release branch, incorporating any bug fixes, will be once every two weeks, given any patches. [main]: https://github.com/etcd-io/etcd/tree/main diff --git a/Documentation/contributor-guide/community-membership.md b/Documentation/contributor-guide/community-membership.md index fa69471a3e2f..946f7a9f65f1 100644 --- a/Documentation/contributor-guide/community-membership.md +++ b/Documentation/contributor-guide/community-membership.md @@ -38,7 +38,7 @@ contributors to the community. - Filing or commenting on issues on GitHub - Contributing to community discussions (e.g. meetings, Slack, email discussion forums, Stack Overflow) -- Subscribed to [etcd-dev@googlegroups.com] +- Subscribed to etcd-dev@googlegroups.com - Have read the [contributor guide] - Sponsored by one active maintainer or two reviewers. - Sponsors must be from multiple member companies to demonstrate integration across community. @@ -114,13 +114,13 @@ depend on to make decisions in the best interest of the project in a consistent - Directly contributed to the project through implementation and / or review - Sponsored by two active maintainers and elected by supermajority - Sponsors must be from multiple member companies to demonstrate integration across community. -- To become a maintainer send an email with your candidacy to [etcd-maintainers-private@googlegroups.com] +- To become a maintainer send an email with your candidacy to etcd-maintainers-private@googlegroups.com - Ensure your sponsors are @mentioned on the email - Include a list of contributions representative of your work on the project. - Existing maintainers vote will privately and respond to the email with either acceptance or with feedback for suggested improvement. - With your membership approved you are expected to: - Open a PR and add an entry to the [MAINTAINERS] file - - Subscribe to [etcd-maintainers@googlegroups.com] and [etcd-maintainers-private@googlegroups.com] + - Subscribe to etcd-maintainers@googlegroups.com and etcd-maintainers-private@googlegroups.com - Request to join to [etcd-maintainer teams of etcd organization of GitHub](https://github.com/orgs/etcd-io/teams/maintainers-etcd) - Request to join to the private slack channel for etcd maintainers on [kubernetes slack](http://slack.kubernetes.io/) - Request access to etcd-development GCP project where we publish releases diff --git a/Makefile b/Makefile index bc7b3f3d92b6..6204a654922d 100644 --- a/Makefile +++ b/Makefile @@ -65,7 +65,7 @@ fuzz: verify: verify-gofmt verify-bom verify-lint verify-dep verify-shellcheck verify-goword \ verify-govet verify-license-header verify-receiver-name verify-mod-tidy verify-shellcheck \ verify-shellws verify-proto-annotations verify-genproto verify-yamllint \ - verify-govet-shadow + verify-govet-shadow verify-markdown-marker fix: fix-bom fix-lint fix-yamllint ./scripts/fix.sh @@ -137,6 +137,10 @@ verify-yamllint: verify-govet-shadow: PASSES="govet_shadow" ./scripts/test.sh +.PHONY: verify-markdown-marker +verify-markdown-marker: + PASSES="markdown_marker" ./scripts/test.sh + YAMLFMT_VERSION = $(shell cd tools/mod && go list -m -f '{{.Version}}' github.com/google/yamlfmt) .PHONY: fix-yamllint