From df79ce47c467823092a3819495418242984ff13e Mon Sep 17 00:00:00 2001
From: Anton Gilgur <4970083+agilgur5@users.noreply.github.com>
Date: Wed, 17 Jan 2024 18:38:24 -0500
Subject: [PATCH] build(docs): auto alphabetize `.spelling` file (#12521)

---
 .github/workflows/docs.yaml |  4 +-
 .spelling                   | 88 ++++++++++++++++++-------------------
 Makefile                    |  2 +
 3 files changed, 46 insertions(+), 48 deletions(-)

diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml
index e0c6c426d00f..10b327fbf82c 100644
--- a/.github/workflows/docs.yaml
+++ b/.github/workflows/docs.yaml
@@ -32,8 +32,8 @@ jobs:
       # Use the same make target both locally and on CI to make it easier to debug failures.
       - name: Build & Lint docs
         run: make docs
-      # If markdownlint fixes issues, files will be changed. If so, fail the build.
-      - name: Check if markdownlint --fix made changes
+      # If linters auto-fix issues, files will be changed. If so, fail the build.
+      - name: Check if linters made changes
         run: git diff --exit-code
       # Upload the site so reviewers see it.
       - name: Upload Docs Site
diff --git a/.spelling b/.spelling
index 2773f3a0684a..31ce1f68aed4 100644
--- a/.spelling
+++ b/.spelling
@@ -1,8 +1,4 @@
-# markdown-spellcheck spelling configuration file
-# Format - lines beginning # are comments
-# global dictionary is at the start, file overrides afterwards
-# one word per line, to define a file override use ' - filename'
-# where filename is relative to this configuration file
+# markdown-spellcheck dictionary
 000s
 0s
 100Mi
@@ -33,41 +29,41 @@ Ang
 Anthos
 Approvers
 ArgoLabs
-argoproj
 Artifactory
 BlackRock
 Breitgand
-Codespaces
-Couler
-ClusterRoles
-ClusterRoleBinding
 CRD
 CRDs
 CloudSQL
+ClusterRoleBinding
+ClusterRoles
+Codespaces
+Couler
+CronWorkflow
+CronWorkflows
 DataDog
 Dataflow
 DevOps
+Devenv
 Dex
-docs
 EditorConfig
 EtcD
 EventRouter
+Generator
 GitOps
 Github
 Golang
-goroutine
-goroutines
 Grafana
 Grammarly
 Hadoop
 Heptio
 Homebrew
+IAM-based
+IPs
 InitContainer
 InsideBoard
 Invocators
-IAM-based
 Istio
-IPs
 Jemison
 JetBrains
 KNative
@@ -78,10 +74,11 @@ Killercoda
 KubectlExec
 Kubeflow
 Kustomize
+LDFlags
 Lifecycle-Hook
 LitmusChaos
-metadata
 MLOps
+Makefile
 MinIO
 Minikube
 MySQL
@@ -92,7 +89,7 @@ Node.JS.
 OAuth
 OAuth2
 Okta
-parameterizing
+OpenAPI
 PDBs
 PProf
 PVCs
@@ -102,27 +99,30 @@ Postgres
 RCs
 Roadmap
 RoleBinding
-s3
-SageMaker
 SDKs
+SageMaker
 ServiceAccount
 Sharding
-shortcodes
 Singer.io
 Snyk
 Sumit
 Tekton
 Traefik
+Triaging
 TripAdvisor
+UI
 VSCode
 Valasek
 Webhooks
 Welch
+WorkflowTemplate
+WorkflowTemplates
 a.m.
 anded
 apis
 architecting
 argo
+argoproj
 args
 async
 auth
@@ -135,7 +135,11 @@ config
 cpu
 cron
 daemoned
+dependabot
+dev
+devenv
 dockershim
+docs
 dropdown
 e.g.
 e2e
@@ -146,10 +150,13 @@ errored
 expr
 fibonacci
 finalizer
+gitops
+goroutine
+goroutines
 govaluate
 gzipped
-Generator
 i.e.
+idempotence
 instantiator
 instantiators
 jenkins
@@ -157,21 +164,28 @@ k3d
 k3s
 k8s-jobs
 kube
+kube-apiserver
+kube-scheduler
+kubectl
 kubelet
 kubernetes
 liveness
 localhost
+maxFailures
+maxSuccess
 memoization
 memoized
 memoizing
+metadata
 minikube
 mutex
 namespace
 namespaces
-non-member
 natively
-OpenAPI
+nix.conf
+non-member
 p.m.
+parameterizing
 params
 pprof
 pre-commit
@@ -180,19 +194,19 @@ repo
 roadmap
 runtime
 runtimes
+s3
 sandboxed
+shortcodes
 stateful
 stderr
-Triaging
 triaged
 un-reconciled
-UI
 v1
 v1.0
 v1.1
 v1.2
-v1.3
 v1.24
+v1.3
 v2
 v2.0
 v2.1
@@ -218,30 +232,12 @@ v3.3.
 v3.4
 v3.4.
 v3.5
-versioned
 validator
+vendored
+versioned
 versioning
 webHDFS
 webhook
 webhooks
 workflow-controller-configmap
-WorkflowTemplate
-WorkflowTemplates
 yaml
-idempotence
-kube-scheduler
-kube-apiserver
-kubectl
-Makefile
-Devenv
-devenv
-vendored
-nix.conf
-LDFlags
-dev
-dependabot
-CronWorkflow
-CronWorkflows
-maxFailures
-maxSuccess
-gitops
diff --git a/Makefile b/Makefile
index b9f81e6acc42..bb7d06aaa8c0 100644
--- a/Makefile
+++ b/Makefile
@@ -685,6 +685,8 @@ endif
 docs-spellcheck: /usr/local/bin/mdspell
 	# check docs for spelling mistakes
 	mdspell --ignore-numbers --ignore-acronyms --en-us --no-suggestions --report $(shell find docs -name '*.md' -not -name upgrading.md -not -name README.md -not -name fields.md -not -name upgrading.md -not -name swagger.md -not -name executor_swagger.md -not -path '*/cli/*')
+	# alphabetize spelling file -- ignore first line (comment), then sort the rest case-sensitive and remove duplicates
+	$(shell cat .spelling | awk 'NR<2{ print $0; next } { print $0 | "sort" }' | uniq | tee .spelling > /dev/null)
 
 /usr/local/bin/markdown-link-check:
 # update this in Nix when upgrading it here