From 5b0a22ca467ddff6390821126b4eabceb428f853 Mon Sep 17 00:00:00 2001 From: Blaine Gardner Date: Thu, 18 Aug 2022 08:58:38 -0600 Subject: [PATCH] ci: update codespell config Codespell had its first release in a year yesterday and added some dictionary rules that are now being flagged in our code. Only one issue required changes to our code, so modify the codespell config to allow the words we want to allow. Signed-off-by: Blaine Gardner --- .github/workflows/codespell.yaml | 9 +++++++-- pkg/operator/ceph/object/objectstore_test.go | 2 +- 2 files changed, 8 insertions(+), 3 deletions(-) diff --git a/.github/workflows/codespell.yaml b/.github/workflows/codespell.yaml index 353ca1a0f..67b6bc6f3 100644 --- a/.github/workflows/codespell.yaml +++ b/.github/workflows/codespell.yaml @@ -30,7 +30,11 @@ jobs: - name: codespell uses: codespell-project/actions-codespell@master with: - skip: .git,*.png,*.jpg,*.svg,*.sum + # LICENSE: skip file because codespell wants to flag complies, which we may want to flag + # in other places, so ignore the file itself assuming it is correct + # crds.yaml, resources.yaml: CRD files are fully generated from content we control (should + # be flagged elsewhere) and content we don't control (can't fix easily), so ignore + skip: .git,*.png,*.jpg,*.svg,*.sum,./LICENSE,./deploy/examples/crds.yaml,./deploy/charts/rook-ceph/templates/resources.yaml # aks: Amazon Kubernetes Service # keyserver: flag to apt-key # atleast: codespell wants to flag any 'AtLeast' method @@ -40,6 +44,7 @@ jobs: # te: udev persistent naming test in pkg/daemon/ceph/osd/daemon_test.go # parm: modinfo parameter # assigment: inherited from K8s TopologySpreadConstraints dependency - ignore_words_list: aks,keyserver,atleast,ser,ist,ba,iam,te,parm,assigment + # ro, RO: means read-only + ignore_words_list: aks,keyserver,atleast,ser,ist,ba,iam,te,parm,assigment,ro,RO check_filenames: true check_hidden: true diff --git a/pkg/operator/ceph/object/objectstore_test.go b/pkg/operator/ceph/object/objectstore_test.go index fd2ddf838..95538d7a2 100644 --- a/pkg/operator/ceph/object/objectstore_test.go +++ b/pkg/operator/ceph/object/objectstore_test.go @@ -910,7 +910,7 @@ func TestUpdateZoneEndpointList(t *testing.T) { }, true, false, }, - {"new endpoint list contains muliple different endpoints from existing list containing single zone", + {"new endpoint list contains multiple different endpoints from existing list containing single zone", args{ zones: []zoneType{{Name: "zone-1", Endpoints: []string{"http://rgw-endpoint-1", "http://rgw-endpoint-2"}}}, zoneEndpointList: []string{"http://rgw-endpoint-3", "http://rgw-endpoint-4"},