Skip to content

Commit

Permalink
fix: company.com -> example.com (#392)
Browse files Browse the repository at this point in the history
company.com is a legit domain, let's use a reserved domain instead in the examples
  • Loading branch information
wass3rw3rk committed Dec 20, 2023
1 parent e788e79 commit 9b1aa7a
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions content/reference/cli/pipeline/exec.md
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

0 comments on commit 9b1aa7a

Please sign in to comment.