Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: company.com -> example.com #392

Merged
merged 1 commit into from
Dec 20, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions content/reference/cli/pipeline/exec.md
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,7 @@ version: "1"

templates:
- name: tmpl
source: git.company.com/cloud/vela-templates/kaniko.yml@main
source: git.example.com/cloud/vela-templates/kaniko.yml@main
type: github

steps:
Expand All @@ -184,7 +184,7 @@ steps:
template:
name: tmpl
vars:
repo: docker.company.com/octocat/hello-world
repo: docker.example.com/octocat/hello-world
```

### kaniko.yml Template
Expand Down Expand Up @@ -213,20 +213,20 @@ steps:
image: target/vela-kaniko:latest
secrets: [ docker_username, docker_password ]
parameters:
registry: docker.company.com
registry: docker.example.com
repo: ${REPO}
```

### Remote Template + Local Environment Onboarding

```sh
$ DOCKER_USERNAME=octocat DOCKER_PASSWORD=abc123 VELA_BUILD_COMMIT=1a2b3c vela exec pipeline --ct <GITHUB_PAT> --cgu https://git.company.com --local-env
$ DOCKER_USERNAME=octocat DOCKER_PASSWORD=abc123 VELA_BUILD_COMMIT=1a2b3c vela exec pipeline --ct <GITHUB_PAT> --cgu https://git.example.com --local-env
```

Note: `--local-env` onboards the entire bash environment. To load specific environment variables, use `--env-vars`:

```sh
$ vela exec pipeline --ct <GITHUB_PAT> --cgu https://git.company.com --env-vars DOCKER_USERNAME=octocat,DOCKER_PASSWORD=abc123,VELA_BUILD_COMMIT=1a2b3c
$ vela exec pipeline --ct <GITHUB_PAT> --cgu https://git.example.com --env-vars DOCKER_USERNAME=octocat,DOCKER_PASSWORD=abc123,VELA_BUILD_COMMIT=1a2b3c
```

### Template Override
Expand All @@ -245,7 +245,7 @@ VELA_BUILD_COMMIT=1a2b3c
```

```sh
$ vela exec pipeline --ct <GITHUB_PAT> --cgu https://git.company.com --env-file
$ vela exec pipeline --ct <GITHUB_PAT> --cgu https://git.example.com --env-file
```

`vela_exec.env`
Expand All @@ -256,15 +256,15 @@ VELA_BUILD_COMMIT=1a2b3c
```

```sh
$ vela exec pipeline --ct <GITHUB_PAT> --cgu https://git.company.com --env-file-path vela_exec.env
$ vela exec pipeline --ct <GITHUB_PAT> --cgu https://git.example.com --env-file-path vela_exec.env
```

### Path Ruleset Inclusion

In order to execute steps with rulesets, be sure to include all necessary flags that match the rules

```sh
$ vela exec pipeline --ct <GITHUB_PAT> --cgu https://git.company.com --env-file --file-changeset src/main.go
$ vela exec pipeline --ct <GITHUB_PAT> --cgu https://git.example.com --env-file --file-changeset src/main.go
```

Other rules: `--branch`, `--event`, `--comment`, `--tag`, `--target`
Expand Down