[v0.17.x] *: remove marker in favor of Github action (#3048) (#3054)

Author: estroz

.github/workflows/markdown-link-check-config.json

@@ -0,0 +1,6 @@
+{
+    "ignorePatterns": [
+        { "pattern": "^https://github.com/\\S+/\\S+/(issues|pull)/[0-9]+" },
+        { "pattern": "^mailto:" }
+    ]
+}

.github/workflows/markdown.yml

@@ -0,0 +1,17 @@
+name: Check Markdown links
+
+on:
+  pull_request:
+  push:
+    branches:
+      - master
+
+jobs:
+  markdown-link-check:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@master
+    - uses: gaurav-nelson/[email protected]
+      with:
+        max-depth: 1
+        config-file: '.github/workflows/markdown-link-check-config.json'

.travis.yml

@@ -109,11 +109,6 @@ jobs:
       script:
         - make test-sanity
 
-    # Run the markdown link checker
-    - name: Markdown Tests
-      script:
-        - make test-markdown
-
     ## Operator test stage jobs ##
 
     # Build and test ansible and test ansible using molecule

Makefile

@@ -209,13 +209,10 @@ image-push-scorecard-test:
 ##@ Tests
 
 # Static tests.
-.PHONY: test test-markdown test-sanity test-unit
+.PHONY: test test-sanity test-unit
 
 test: test-unit ## Run the tests
 
-test-markdown:
-	./hack/check-markdown.sh
-
 test-sanity: tidy build/operator-sdk lint
 	./hack/tests/sanity-check.sh
 
@@ -225,7 +222,7 @@ test-unit: ## Run the unit tests
 # CI tests.
 .PHONY: test-ci
 
-test-ci: test-markdown test-sanity test-unit install test-subcommand test-e2e ## Run the CI test suite
+test-ci: test-sanity test-unit install test-subcommand test-e2e ## Run the CI test suite
 
 # Subcommand tests.
 .PHONY: test-subcommand test-subcommand-local test-subcommand-scorecard test-subcommand-olm-install

hack/check-markdown.sh

@@ -57,7 +57,7 @@ $ export KUBECONFIG="$(kind get kubeconfig-path --name="kind")"
 All the tests are run through the [`Makefile`][makefile]. This is a brief description of all makefile test instructions:
 
 - `test` - Runs the unit tests (`test-unit`).
-- `test-ci` - Runs markdown, sanity, and unit tests, installs the SDK binary, and runs the SDK subcommand and all E2E tests.
+- `test-ci` - Runs sanity and unit tests, installs the SDK binary, and runs the SDK subcommand and all E2E tests.
 - `test-sanity` - Runs sanity checks.
 - `test-unit` - Runs unit tests.
 - `test-subcommand` - Runs subcommand tests.
@@ -66,7 +66,6 @@ All the tests are run through the [`Makefile`][makefile]. This is a brief descri
 - `test-e2e-ansible` - Runs the ansible E2E test.
 - `test-e2e-ansible-molecule` - Runs the ansible molecule E2E test.
 - `test-e2e-helm` - Runs the helm E2E test.
-- `test-markdown` - Runs the markdown checks
 
 For more info on what these tests actually do, please see the [Travis Build][travis] doc.
 

hack/ci/marker

@@ -13,7 +13,6 @@ In Travis CI, 4 jobs are run to test the sdk:
 - [Go](#go-tests)
 - [Ansible](#ansible-tests)
 - [Helm](#helm-tests)
-- [Markdown](#markdown)
 
 ### Before Install for Go, Ansible, and Helm
 
@@ -104,12 +103,6 @@ The Go, Ansible, and Helm tests then differ in what tests they run.
 
 **NOTE**: All created resources, including the namespace, are deleted using a bash trap when the test finishes
 
-### Markdown
-
-The markdown test does not create a new cluster and runs in a barebones Travis VM configured only for `bash`. This allows documentation PRs to pass quickly, as they don't require code tests. The markdown checker uses a precompiled version of [`marker`][marker-github] stored in [`hack/ci/marker`][marker-local] to check the validity and correctness of the links in all markdown files in the `doc` directory.
-
-**NOTE**: There is currently a bug in marker that causes link with underscores (`_`) to not be checked correctly.
-
 [branches]: https://travis-ci.org/operator-framework/operator-sdk/branches
 [pr-builds]: https://travis-ci.org/operator-framework/operator-sdk/pull_requests
 [k8s-script]: https://github.com/operator-framework/operator-sdk/blob/master/hack/ci/setup-k8s.sh
@@ -122,6 +115,4 @@ The markdown test does not create a new cluster and runs in a barebones Travis V
 [ansible-test]: https://github.com/operator-framework/operator-sdk/tree/master/test/ansible
 [helm-e2e]: https://github.com/operator-framework/operator-sdk/blob/master/hack/tests/e2e-helm.sh
 [helm-base]: https://github.com/operator-framework/operator-sdk/blob/master/hack/image/helm/scaffold-helm-image.go
-[marker-github]: https://github.com/crawford/marker
-[marker-local]: https://github.com/operator-framework/operator-sdk/blob/master/hack/ci/marker
 [deps_mgmt]: ../../../golang/quickstart#a-note-on-dependency-management