generated from knative-extensions/sample-controller
-
Notifications
You must be signed in to change notification settings - Fork 78
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit 099a7a8
Showing
3,425 changed files
with
1,053,631 additions
and
0 deletions.
The diff you're trying to view is too large. We only load the first 3000 changed files.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
# This file is documented at https://git-scm.com/docs/gitattributes. | ||
# Linguist-specific attributes are documented at | ||
# https://github.com/github/linguist. | ||
|
||
**/zz_generated.*.go linguist-generated=true | ||
/pkg/client/** linguist-generated=true | ||
/test/client/** linguist-generated=true | ||
|
||
# coverage-excluded is an attribute used to explicitly exclude a path from being included in code | ||
# coverage. If a path is marked as linguist-generated already, it will be implicitly excluded and | ||
# there is no need to add the coverage-excluded attribute | ||
/pkg/**/testing/** coverage-excluded=true | ||
/vendor/** coverage-excluded=true | ||
/test/** coverage-excluded=true | ||
/cmd/**/main.go coverage-excluded=true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
# Operating system temporary files | ||
.DS_Store | ||
|
||
# Editor/IDE specific settings | ||
.idea | ||
.vscode/ | ||
*.iml | ||
|
||
# Temporary output of build tools | ||
bazel-* | ||
*.out |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
# Contribution guidelines | ||
|
||
So you want to hack on Knative `sample-controller`? Yay! Please refer to | ||
Knative's overall | ||
[contribution guidelines](https://www.knative.dev/contributing/) to find out how | ||
you can help. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,73 @@ | ||
# Development | ||
|
||
This doc explains how to setup a development environment so you can get started | ||
[contributing](https://www.knative.dev/contributing/) to Knative | ||
`sample-controller`. Also take a look at: | ||
|
||
- [The pull request workflow](https://knative.dev/community/contributing/reviewing/) | ||
|
||
## Getting started | ||
|
||
1. Create [a GitHub account](https://github.com/join) | ||
1. Setup | ||
[GitHub access via SSH](https://help.github.com/articles/connecting-to-github-with-ssh/) | ||
1. Install [requirements](#requirements) | ||
1. Set up your [shell environment](#environment-setup) | ||
1. [Create and checkout a repo fork](#checkout-your-fork) | ||
|
||
Before submitting a PR, see also [CONTRIBUTING.md](./CONTRIBUTING.md). | ||
|
||
### Requirements | ||
|
||
You must install these tools: | ||
|
||
1. [`go`](https://golang.org/doc/install): The language Knative | ||
`sample-controller` is built in | ||
1. [`git`](https://help.github.com/articles/set-up-git/): For source control | ||
1. [`dep`](https://github.com/golang/dep): For managing external dependencies. | ||
|
||
### Environment setup | ||
|
||
To get started you'll need to set these environment variables (we recommend | ||
adding them to your `.bashrc`): | ||
|
||
1. `GOPATH`: If you don't have one, simply pick a directory and add | ||
`export GOPATH=...` | ||
|
||
1. `$GOPATH/bin` on `PATH`: This is so that tooling installed via `go get` will | ||
work properly. | ||
|
||
`.bashrc` example: | ||
|
||
```shell | ||
export GOPATH="$HOME/go" | ||
export PATH="${PATH}:${GOPATH}/bin" | ||
``` | ||
|
||
### Checkout your fork | ||
|
||
The Go tools require that you clone the repository to the | ||
`src/knative.dev/sample-controller` directory in your | ||
[`GOPATH`](https://github.com/golang/go/wiki/SettingGOPATH). | ||
|
||
To check out this repository: | ||
|
||
1. Create your own | ||
[fork of this repo](https://help.github.com/articles/fork-a-repo/) | ||
|
||
1. Clone it to your machine: | ||
|
||
```shell | ||
mkdir -p ${GOPATH}/src/knative.dev | ||
cd ${GOPATH}/src/knative.dev | ||
git clone [email protected]:${YOUR_GITHUB_USERNAME}/sample-controller.git | ||
cd sample-controller | ||
git remote add upstream https://knative.dev/sample-controller.git | ||
git remote set-url --push upstream no_push | ||
``` | ||
|
||
_Adding the `upstream` remote sets you up nicely for regularly | ||
[syncing your fork](https://help.github.com/articles/syncing-a-fork/)._ | ||
|
||
Once you reach this point you are ready to do a full build and deploy as | ||
described below. |
Oops, something went wrong.