Skip to content

Commit cc18d48

Browse files
AlexNPaveljoelanford
authored andcommitted
hack/ci/marker: update marker (#2146)
Update marker to v0.8.0. As before, this was built in a CentOS 7 VM, which allows it to run in both Travis and API-CI, and then was stripped, then compressed by UPX. Marker v0.8.0 fixes the `_` issue that was previously causing problems in some PRs that changed markdown files, adds support for Github style checklists using `[]`, and adds a --exclude flag. The other changes in the PR are changing the Makefile to run marker on the entire project tree and fixes a couple of new broken references/URLs found by marker.
1 parent efdfab5 commit cc18d48

File tree

4 files changed

+6
-6
lines changed

4 files changed

+6
-6
lines changed

CHANGELOG.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
### Changed
2222

2323
- **Breaking change:** Changed required Go version from `1.12` to `1.13`. This change applies to the SDK project itself and Go projects scaffolded by the SDK. Projects that import this version of the SDK require Go 1.13 to compile. ([#1949](https://github.com/operator-framework/operator-sdk/pull/1949))
24-
24+
2525
### Deprecated
2626
- Upgrade Kubernetes version from `kubernetes-1.14.1` to `kubernetes-1.15.4`. ([#2083](https://github.com/operator-framework/operator-sdk/pull/2083))
2727
- Upgrade Helm version from `v2.14.1` to `v2.15.0`. ([#2083](https://github.com/operator-framework/operator-sdk/pull/2083))
@@ -88,7 +88,7 @@
8888
err = r.client.List(context.TODO(), listOps, podList)
8989
// New
9090
listOpts := []client.ListOption{
91-
client.InNamespace("namespace"),
91+
client.InNamespace("namespace"),
9292
}
9393
err = r.client.List(context.TODO(), podList, listOpts...)
9494
```
@@ -124,7 +124,7 @@
124124

125125
### Changed
126126

127-
- **Breaking Change:** New configuration format for the `operator-sdk scorecard` using config files. See [`doc/test-framework/scorecard`](doc/test-framework/scorecard) for more info ([#1641](https://github.com/operator-framework/operator-sdk/pull/1641))
127+
- **Breaking Change:** New configuration format for the `operator-sdk scorecard` using config files. See [`doc/test-framework/scorecard`](doc/test-framework/scorecard.md) for more info ([#1641](https://github.com/operator-framework/operator-sdk/pull/1641))
128128
- **Breaking change:** CSV config field `role-path` is now `role-paths` and takes a list of strings. Users can now specify multiple `Role` and `ClusterRole` manifests using `role-paths`. ([#1704](https://github.com/operator-framework/operator-sdk/pull/1704))
129129
- Make `ready` package idempotent. Now, a user can call `Set()` or `Unset()` to set the operator's readiness without knowing the current state. ([#1761](https://github.com/operator-framework/operator-sdk/pull/1761))
130130
@@ -350,7 +350,7 @@
350350
### Changed
351351
352352
- The SDK now uses logr as the default logger to unify the logging output with the controller-runtime logs. Users can still use a logger of their own choice. See the [logging doc](https://github.com/operator-framework/operator-sdk/blob/master/doc/user/logging.md) on how the SDK initializes and uses logr.
353-
- Ansible Operator CR status better aligns with [conventions](https://github.com/kubernetes/community/blob/master/contributors/devel/api-conventions.md#typical-status-properties). ([#639](https://github.com/operator-framework/operator-sdk/pull/639))
353+
- Ansible Operator CR status better aligns with [conventions](https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#typical-status-properties). ([#639](https://github.com/operator-framework/operator-sdk/pull/639))
354354
355355
### Added
356356

Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ build/%.asc:
107107
test: test-unit ## Run the tests
108108

109109
test-markdown test/markdown:
110-
./hack/ci/marker --root=doc
110+
./hack/ci/marker
111111

112112
test-sanity test/sanity: tidy
113113
./hack/tests/sanity-check.sh

doc/sdk-cli-reference.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -335,7 +335,7 @@ Adds a new controller under `pkg/controller/<kind>/...` that, by default, reconc
335335

336336
* `--api-version` string - CRD APIVersion in the format `$GROUP_NAME/$VERSION` (e.g app.example.com/v1alpha1)
337337
* `--kind` string - CRD Kind. (e.g AppService)
338-
* `--custom-api-import` string - External Kubernetes resource import path of the form "host.com/repo/path[=import_identifier]". import_identifier is optional
338+
* `--custom-api-import` string - External Kubernetes resource import path of the form "host.com/repo/path\[=import_identifier\]". import_identifier is optional
339339

340340
#### Example
341341

hack/ci/marker

36.4 KB
Binary file not shown.

0 commit comments

Comments
 (0)