Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add markdownlint make targets #196

Merged
merged 3 commits into from
Jan 15, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ about: Suggest an idea for this project

What new functionality do you want?

# Who is the end user and what is the use case where this feature will be valuable?
## Who is the end user and what is the use case where this feature will be valuable? ##

Who is going to use this feature and under what circumstances?

Expand Down
6 changes: 2 additions & 4 deletions .github/workflows/lint.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -76,10 +76,8 @@ jobs:
- uses: actions/checkout@v4
with:
fetch-depth: 1
- uses: DavidAnson/markdownlint-cli2-action@v19
with:
config: .markdownlint.yaml
globs: 'docs/*.md'
- name: run markdownlint
run: make markdownlint

shellcheck:
name: Shellcheck
Expand Down
13 changes: 11 additions & 2 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -134,16 +134,25 @@ test-e2e:
go test ./test/e2e/ -v -ginkgo.v


MARKDOWNLINT_IMAGE = docker.io/davidanson/markdownlint-cli2:v0.17.1
.PHONY: markdownlint
markdownlint:
@$(CONTAINER_TOOL) run --platform linux/amd64 -v .\:/workdir\:z $(MARKDOWNLINT_IMAGE) markdownlint-cli2 "**.md" "#vendor/**" --config .markdownlint.yaml

.PHONY: markdownlint-fix
markdownlint-fix:
@$(CONTAINER_TOOL) run --platform linux/amd64 -v .\:/workdir\:z $(MARKDOWNLINT_IMAGE) markdownlint-cli2 "**.md" "#vendor/**" --config .markdownlint.yaml --fix


.PHONY: golangci-lint-fix
golangci-lint-fix: $(GOLANGCI_LINT) ## Run the golangci-lint linter and perform fixes
@$(GOLANGCI_LINT) --config=.golangci.yml -verbose run --fix


.PHONY: lint
lint: golangci-lint ## Run various linters
lint: golangci-lint markdownlint ## Run various linters
.PHONY: lint-fix
lint-fix: golangci-lint-fix ## run linters and perform fixes
lint-fix: golangci-lint-fix markdownlint-fix## run linters and perform fixes

##@ Build

Expand Down
2 changes: 1 addition & 1 deletion docs/design/hostNetwork.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Enabling host networking for controller plugin pods

By default, the Ceph-CSI controller plugins operate on the pod network
but under some circumstances, like setups with a dedicated storage network,
but under some circumstances, like setups with a dedicated storage network,
where the pod network cannot connect to the ceph cluster,
it is necessary to run the Ceph-CSI controller plugin pods on the host network.

Expand Down
2 changes: 1 addition & 1 deletion docs/design/logrotate.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Log rotation involves managing log files by controlling their size. This feature will be added to the CephCSI and csi-addons containers in the CephCSI node-plugin and controller-plugin pods. When logrotate is used, it will generate a log file at the host path and run the logrotator sidecar container in CephCSI pods. The logrotator sidecar container will then ensure that log files are rotated based on predefined settings.

Logroate configuration,
Logroate configuration,

`OperatorConfig CRD`:

Expand Down
4 changes: 2 additions & 2 deletions docs/design/operator.md
Original file line number Diff line number Diff line change
Expand Up @@ -358,8 +358,8 @@ status: {}

The ClientProfileMapping CR contains a mapping between pairs of Ceph
CSI client profiles. The information in this CR helps Ceph CSI identify
peered configuration between different k8s cluster. This information is
utilized in the management and consumption of volumes in backup and
peered configuration between different k8s cluster. This information is
utilized in the management and consumption of volumes in backup and
DR scenarios

```yaml
Expand Down
Loading