You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.MD
+6-3Lines changed: 6 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,11 +9,11 @@ Operator SDK is Apache 2.0 licensed and accepts contributions via GitHub pull re
9
9
## Getting started
10
10
11
11
- Fork the repository on GitHub
12
-
- See the [developer guide](https://sdk.operatorframework.io/docs/contribution-guidelines/developer-guide/) for build instructions
12
+
- See the [developer guide][developer-guide] for build instructions
13
13
14
14
## Reporting bugs and creating issues
15
15
16
-
Reporting bugs is one of the best ways to contribute. However, a good bug report has some very specific qualities, so please read over our short document on [reporting bugs](./doc/dev/reporting_bugs.md) before submitting a bug report. This document might contain links to known issues, another good reason to take a look there before reporting a bug.
16
+
Reporting bugs is one of the best ways to contribute. However, a good bug report has some very specific qualities, so please read over our short document on [reporting issues][reporting-issues] before submitting a bug report. This document might contain links to known issues, another good reason to take a look there before reporting a bug.
17
17
18
18
## Contribution flow
19
19
@@ -30,7 +30,7 @@ Thanks for contributing!
30
30
31
31
### Code style
32
32
33
-
The coding style suggested by the Golang community is used in operator-sdk. See the [style doc](https://github.com/golang/go/wiki/CodeReviewComments) for details.
33
+
The coding style suggested by the Golang community is used in operator-sdk. See the [style doc][golang-style-doc] for details.
34
34
35
35
Please follow this style to make operator-sdk easy to review, maintain and develop.
36
36
@@ -66,4 +66,7 @@ If the contribution changes the existing APIs or user interface it must include
Copy file name to clipboardExpand all lines: website/content/en/docs/contribution-guidelines/release.md
+18-18Lines changed: 18 additions & 18 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -27,7 +27,7 @@ As the Operator SDK interacts directly with the Kubernetes API, certain API feat
27
27
28
28
Release binaries will be built for the `x86_64` architecture for MacOS Darwin platform and for the following GNU Linux architectures: `x86_64`, `ppc64le`, `s390x`.
29
29
30
-
Base images for ansible-operator, helm-operator, and scorecard-proxy will be built for the following GNU Linux architectures: `x86_64`, `ppc64le`, `s390x`.
30
+
Base images for ansible-operator, helm-operator, scorecard-proxy, and scorecard-test will be built for the following GNU Linux architectures: `x86_64`, `ppc64le`, `s390x`.
31
31
32
32
Support for the Windows platform is not on the roadmap at this time.
If you do not have the mantainers public key on your machine, you will get an error message similiar to this:
156
156
157
-
```sh
158
-
git verify-tag --verbose "$TAG_NAME"
157
+
```console
158
+
$ git verify-tag --verbose "$TAG_NAME"
159
159
object 61e0c23e9d2e217f8d95ac104a8f2545c102b5c3
160
160
type commit
161
161
tag v0.6.0
@@ -230,7 +230,7 @@ Commit the following changes:
230
230
-`internal/scaffold/go_mod.go`, change the `require` line version for `github.com/operator-framework/operator-sdk` from `master` to `v1.3.0`.
231
231
-`internal/scaffold/helm/go_mod.go`: same as for `internal/scaffold/go_mod.go`.
232
232
-`internal/scaffold/ansible/go_mod.go`: same as for `internal/scaffold/go_mod.go`.
233
-
- `doc/user/install-operator-sdk.md`: update the linux and macOS URLs to point to the new release URLs.
233
+
-`website/content/en/docs/install-operator-sdk.md`: update the linux and macOS URLs to point to the new release URLs.
234
234
-`CHANGELOG.md`: commit changes (updated by changelog generation).
235
235
-`website/content/en/docs/migration/v1.3.0.md`: commit changes (created by changelog generation).
236
236
-`changelog/fragments/*`: commit deleted fragment files (deleted by changelog generation).
@@ -311,18 +311,18 @@ Now that the branch exists, you need to make the post-release PR for the new rel
311
311
We support installing via [Homebrew][homebrew], so we need to update the operator-sdk [Homebrew formula][homebrew-formula] once the release is cut. Follow the instructions below, or for more detailed ones on the Homebrew contribution [README][homebrew-readme], to open a PR against the [repository][homebrew-repo].
312
312
313
313
314
-
```
315
-
docker run -t -d linuxbrew/brew:latest
316
-
docker exec -it <CONTAINER_ID> /bin/bash`
314
+
```sh
315
+
$ docker run -t -d linuxbrew/brew:latest --name homebrew
0 commit comments