Make exec run be detected as WoodpeckerCI (#1218)

and exclude docs/docs/40-cli.md from git as it will be generated by CI
This commit is contained in:
6543 2022-09-27 22:19:39 +02:00 committed by GitHub
parent 7838f84b69
commit a39e8a0f9a
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 12 additions and 887 deletions

3
.gitignore vendored
View file

@ -48,3 +48,6 @@ docs/venv
# helm charts # helm charts
.cr-index/ .cr-index/
.cr-release-packages/ .cr-release-packages/
### Generated by CI ###
docs/docs/40-cli.md

View file

@ -1,14 +1,20 @@
variables: variables:
- &golang_image 'golang:1.18'
- &node_image 'node:16-alpine' - &node_image 'node:16-alpine'
- &when_path - &when_path
- "docs/**" - "docs/**"
- ".woodpecker/docs.yml" - ".woodpecker/docs.yml"
# since we genereate docs for cli tool we have to watch this too
- "cli/**"
- "cmd/cli/**"
pipeline: pipeline:
build-cli: build-cli:
image: golang:1.18 image: *golang_image
commands: commands:
- make docs - make docs
when:
path: *when_path
build: build:
image: *node_image image: *node_image
@ -17,7 +23,6 @@ pipeline:
- yarn install --frozen-lockfile - yarn install --frozen-lockfile
- yarn build - yarn build
when: when:
event: [push, pull_request]
path: *when_path path: *when_path
securitycheck: securitycheck:

View file

@ -107,12 +107,12 @@ var flags = []cli.Flag{
&cli.StringFlag{ &cli.StringFlag{
EnvVars: []string{"CI_SYSTEM_NAME"}, EnvVars: []string{"CI_SYSTEM_NAME"},
Name: "system-name", Name: "system-name",
Value: "pipec", Value: "woodpecker",
}, },
&cli.StringFlag{ &cli.StringFlag{
EnvVars: []string{"CI_SYSTEM_LINK"}, EnvVars: []string{"CI_SYSTEM_LINK"},
Name: "system-link", Name: "system-link",
Value: "https://github.com/cncd/pipec", Value: "https://github.com/woodpecker-ci/woodpecker",
}, },
&cli.StringFlag{ &cli.StringFlag{
EnvVars: []string{"CI_REPO_NAME"}, EnvVars: []string{"CI_REPO_NAME"},

View file

@ -1,883 +0,0 @@
# CLI
# NAME
woodpecker-cli - command line utility
# SYNOPSIS
woodpecker-cli
```
[--log-level]=[value]
[--server|-s]=[value]
[--token|-t]=[value]
```
**Usage**:
```
woodpecker-cli [GLOBAL OPTIONS] command [COMMAND OPTIONS] [ARGUMENTS...]
```
# GLOBAL OPTIONS
**--log-level**="": set logging level (default: info)
**--server, -s**="": server address
**--token, -t**="": server auth token
# COMMANDS
## build
manage builds
**--log-level**="": set logging level (default: info)
**--server, -s**="": server address
**--token, -t**="": server auth token
### ls
show build history
**--branch**="": branch filter
**--event**="": event filter
**--format**="": format output (default: Build #{{ .Number }} 
Status: {{ .Status }}
Event: {{ .Event }}
Commit: {{ .Commit }}
Branch: {{ .Branch }}
Ref: {{ .Ref }}
Author: {{ .Author }} {{ if .Email }}<{{.Email}}>{{ end }}
Message: {{ .Message }}
)
**--limit**="": limit the list size (default: 25)
**--log-level**="": set logging level (default: info)
**--server, -s**="": server address
**--status**="": status filter
**--token, -t**="": server auth token
### last
show latest build details
**--branch**="": branch name (default: master)
**--format**="": format output (default: Number: {{ .Number }}
Status: {{ .Status }}
Event: {{ .Event }}
Commit: {{ .Commit }}
Branch: {{ .Branch }}
Ref: {{ .Ref }}
Message: {{ .Message }}
Author: {{ .Author }}
)
**--log-level**="": set logging level (default: info)
**--server, -s**="": server address
**--token, -t**="": server auth token
### logs
show build logs
**--log-level**="": set logging level (default: info)
**--server, -s**="": server address
**--token, -t**="": server auth token
### info
show build details
**--format**="": format output (default: Number: {{ .Number }}
Status: {{ .Status }}
Event: {{ .Event }}
Commit: {{ .Commit }}
Branch: {{ .Branch }}
Ref: {{ .Ref }}
Message: {{ .Message }}
Author: {{ .Author }}
)
**--log-level**="": set logging level (default: info)
**--server, -s**="": server address
**--token, -t**="": server auth token
### stop
stop a build
**--log-level**="": set logging level (default: info)
**--server, -s**="": server address
**--token, -t**="": server auth token
### start
start a build
**--log-level**="": set logging level (default: info)
**--param, -p**="": custom parameters to be injected into the job environment. Format: KEY=value
**--server, -s**="": server address
**--token, -t**="": server auth token
### approve
approve a build
**--log-level**="": set logging level (default: info)
**--server, -s**="": server address
**--token, -t**="": server auth token
### decline
decline a build
**--log-level**="": set logging level (default: info)
**--server, -s**="": server address
**--token, -t**="": server auth token
### queue
show build queue
**--format**="": format output (default: {{ .FullName }} #{{ .Number }} 
Status: {{ .Status }}
Event: {{ .Event }}
Commit: {{ .Commit }}
Branch: {{ .Branch }}
Ref: {{ .Ref }}
Author: {{ .Author }} {{ if .Email }}<{{.Email}}>{{ end }}
Message: {{ .Message }}
)
**--log-level**="": set logging level (default: info)
**--server, -s**="": server address
**--token, -t**="": server auth token
### ps
show build steps
**--format**="": format output (default: Proc #{{ .PID }} 
Step: {{ .Name }}
State: {{ .State }}
)
**--log-level**="": set logging level (default: info)
**--server, -s**="": server address
**--token, -t**="": server auth token
### create
create new build
**--branch**="": branch to create build from
**--format**="": format output (default: Build #{{ .Number }} 
Status: {{ .Status }}
Event: {{ .Event }}
Commit: {{ .Commit }}
Branch: {{ .Branch }}
Ref: {{ .Ref }}
Author: {{ .Author }} {{ if .Email }}<{{.Email}}>{{ end }}
Message: {{ .Message }}
)
**--log-level**="": set logging level (default: info)
**--server, -s**="": server address
**--token, -t**="": server auth token
**--var**="": key=value
## log
manage logs
**--log-level**="": set logging level (default: info)
**--server, -s**="": server address
**--token, -t**="": server auth token
### purge
purge a log
**--log-level**="": set logging level (default: info)
**--server, -s**="": server address
**--token, -t**="": server auth token
## deploy
deploy code
**--branch**="": branch filter (default: master)
**--event**="": event filter (default: push)
**--format**="": format output (default: Number: {{ .Number }}
Status: {{ .Status }}
Commit: {{ .Commit }}
Branch: {{ .Branch }}
Ref: {{ .Ref }}
Message: {{ .Message }}
Author: {{ .Author }}
Target: {{ .Deploy }}
)
**--log-level**="": set logging level (default: info)
**--param, -p**="": custom parameters to be injected into the job environment. Format: KEY=value
**--server, -s**="": server address
**--status**="": status filter (default: success)
**--token, -t**="": server auth token
## exec
execute a local build
**--backend-engine**="": backend engine to run pipelines on (default: auto-detect)
**--backend-k8s-namespace**="": backend k8s namespace (default: woodpecker)
**--backend-k8s-storage-class**="": backend k8s storage class
**--backend-k8s-storage-rwx**: backend k8s storage access mode, should ReadWriteMany (RWX) instead of ReadWriteOnce (RWO) be used? (default: true)
**--backend-k8s-volume-size**="": backend k8s volume size (default 10G) (default: 10G)
**--build-created**="": (default: 0)
**--build-event**="": (default: manual)
**--build-finished**="": (default: 0)
**--build-link**="":
**--build-number**="": (default: 0)
**--build-started**="": (default: 0)
**--build-status**="":
**--build-target**="":
**--commit-author-avatar**="":
**--commit-author-email**="":
**--commit-author-name**="":
**--commit-branch**="":
**--commit-message**="":
**--commit-ref**="":
**--commit-refspec**="":
**--commit-sha**="":
**--env**="":
**--job-number**="": (default: 0)
**--local**: build from local directory
**--log-level**="": set logging level (default: info)
**--netrc-machine**="":
**--netrc-password**="":
**--netrc-username**="":
**--network**="": external networks
**--parent-build-number**="": (default: 0)
**--prev-build-created**="": (default: 0)
**--prev-build-event**="":
**--prev-build-finished**="": (default: 0)
**--prev-build-link**="":
**--prev-build-number**="": (default: 0)
**--prev-build-started**="": (default: 0)
**--prev-build-status**="":
**--prev-commit-author-avatar**="":
**--prev-commit-author-email**="":
**--prev-commit-author-name**="":
**--prev-commit-branch**="":
**--prev-commit-message**="":
**--prev-commit-ref**="":
**--prev-commit-refspec**="":
**--prev-commit-sha**="":
**--privileged**="": privileged plugins (default: [plugins/docker plugins/gcr plugins/ecr woodpeckerci/plugin-docker woodpeckerci/plugin-docker-buildx])
**--repo-link**="":
**--repo-name**="":
**--repo-private**="":
**--repo-remote-url**="":
**--server, -s**="": server address
**--system-link**="": (default: https://github.com/cncd/pipec)
**--system-name**="": (default: pipec)
**--system-platform**="":
**--timeout**="": build timeout (default: 1h0m0s)
**--token, -t**="": server auth token
**--volumes**="": build volumes
**--workspace-base**="": (default: /woodpecker)
**--workspace-path**="": (default: src)
## info
show information about the current user
**--log-level**="": set logging level (default: info)
**--server, -s**="": server address
**--token, -t**="": server auth token
## registry
manage registries
**--log-level**="": set logging level (default: info)
**--server, -s**="": server address
**--token, -t**="": server auth token
### add
adds a registry
**--hostname**="": registry hostname (default: docker.io)
**--log-level**="": set logging level (default: info)
**--password**="": registry password
**--repository, --repo**="": repository name (e.g. octocat/hello-world)
**--server, -s**="": server address
**--token, -t**="": server auth token
**--username**="": registry username
### rm
remove a registry
**--hostname**="": registry hostname (default: docker.io)
**--log-level**="": set logging level (default: info)
**--repository, --repo**="": repository name (e.g. octocat/hello-world)
**--server, -s**="": server address
**--token, -t**="": server auth token
### update
update a registry
**--hostname**="": registry hostname (default: docker.io)
**--log-level**="": set logging level (default: info)
**--password**="": registry password
**--repository, --repo**="": repository name (e.g. octocat/hello-world)
**--server, -s**="": server address
**--token, -t**="": server auth token
**--username**="": registry username
### info
display registry info
**--hostname**="": registry hostname (default: docker.io)
**--log-level**="": set logging level (default: info)
**--repository, --repo**="": repository name (e.g. octocat/hello-world)
**--server, -s**="": server address
**--token, -t**="": server auth token
### ls
list registries
**--log-level**="": set logging level (default: info)
**--repository, --repo**="": repository name (e.g. octocat/hello-world)
**--server, -s**="": server address
**--token, -t**="": server auth token
## secret
manage secrets
**--log-level**="": set logging level (default: info)
**--server, -s**="": server address
**--token, -t**="": server auth token
### add
adds a secret
**--event**="": secret limited to these events
**--global**: global secret
**--image**="": secret limited to these images
**--log-level**="": set logging level (default: info)
**--name**="": secret name
**--organization**="": organization name (e.g. octocat)
**--repository, --repo**="": repository name (e.g. octocat/hello-world)
**--server, -s**="": server address
**--token, -t**="": server auth token
**--value**="": secret value
### rm
remove a secret
**--global**: global secret
**--log-level**="": set logging level (default: info)
**--name**="": secret name
**--organization**="": organization name (e.g. octocat)
**--repository, --repo**="": repository name (e.g. octocat/hello-world)
**--server, -s**="": server address
**--token, -t**="": server auth token
### update
update a secret
**--event**="": secret limited to these events
**--global**: global secret
**--image**="": secret limited to these images
**--log-level**="": set logging level (default: info)
**--name**="": secret name
**--organization**="": organization name (e.g. octocat)
**--repository, --repo**="": repository name (e.g. octocat/hello-world)
**--server, -s**="": server address
**--token, -t**="": server auth token
**--value**="": secret value
### info
display secret info
**--global**: global secret
**--log-level**="": set logging level (default: info)
**--name**="": secret name
**--organization**="": organization name (e.g. octocat)
**--repository, --repo**="": repository name (e.g. octocat/hello-world)
**--server, -s**="": server address
**--token, -t**="": server auth token
### ls
list secrets
**--global**: global secret
**--log-level**="": set logging level (default: info)
**--organization**="": organization name (e.g. octocat)
**--repository, --repo**="": repository name (e.g. octocat/hello-world)
**--server, -s**="": server address
**--token, -t**="": server auth token
## repo
manage repositories
**--log-level**="": set logging level (default: info)
**--server, -s**="": server address
**--token, -t**="": server auth token
### ls
list all repos
**--format**="": format output (default: {{ .FullName }})
**--log-level**="": set logging level (default: info)
**--org**="": filter by organization
**--server, -s**="": server address
**--token, -t**="": server auth token
### info
show repository details
**--format**="": format output (default: Owner: {{ .Owner }}
Repo: {{ .Name }}
Type: {{ .SCMKind }}
Config: {{ .Config }}
Visibility: {{ .Visibility }}
Private: {{ .IsSCMPrivate }}
Trusted: {{ .IsTrusted }}
Gated: {{ .IsGated }}
Remote: {{ .Clone }}
)
**--log-level**="": set logging level (default: info)
**--server, -s**="": server address
**--token, -t**="": server auth token
### add
add a repository
**--log-level**="": set logging level (default: info)
**--server, -s**="": server address
**--token, -t**="": server auth token
### update
update a repository
**--build-counter**="": repository starting build number (default: 0)
**--config**="": repository configuration path (e.g. .woodpecker.yml)
**--gated**: repository is gated
**--log-level**="": set logging level (default: info)
**--server, -s**="": server address
**--timeout**="": repository timeout (default: 0s)
**--token, -t**="": server auth token
**--trusted**: repository is trusted
**--unsafe**: validate updating the build-counter is unsafe
**--visibility**="": repository visibility
### rm
remove a repository
**--log-level**="": set logging level (default: info)
**--server, -s**="": server address
**--token, -t**="": server auth token
### repair
repair repository webhooks
**--log-level**="": set logging level (default: info)
**--server, -s**="": server address
**--token, -t**="": server auth token
### chown
assume ownership of a repository
**--log-level**="": set logging level (default: info)
**--server, -s**="": server address
**--token, -t**="": server auth token
### sync
synchronize the repository list
**--format**="": format output (default: {{ .FullName }})
**--log-level**="": set logging level (default: info)
**--server, -s**="": server address
**--token, -t**="": server auth token
## user
manage users
**--log-level**="": set logging level (default: info)
**--server, -s**="": server address
**--token, -t**="": server auth token
### ls
list all users
**--format**="": format output (default: {{ .Login }})
**--log-level**="": set logging level (default: info)
**--server, -s**="": server address
**--token, -t**="": server auth token
### info
show user details
**--format**="": format output (default: User: {{ .Login }}
Email: {{ .Email }})
**--log-level**="": set logging level (default: info)
**--server, -s**="": server address
**--token, -t**="": server auth token
### add
adds a user
**--log-level**="": set logging level (default: info)
**--server, -s**="": server address
**--token, -t**="": server auth token
### rm
remove a user
**--log-level**="": set logging level (default: info)
**--server, -s**="": server address
**--token, -t**="": server auth token
## lint
lint a pipeline configuration file
**--log-level**="": set logging level (default: info)
**--server, -s**="": server address
**--token, -t**="": server auth token
## log-level
get the logging level of the server, or set it with [level]
**--log-level**="": set logging level (default: info)
**--server, -s**="": server address
**--token, -t**="": server auth token
## cron
manage cron jobs
**--log-level**="": set logging level (default: info)
**--server, -s**="": server address
**--token, -t**="": server auth token
### add
adds a cron
**--branch**="": cron branch
**--log-level**="": set logging level (default: info)
**--name**="": cron name
**--repository, --repo**="": repository name (e.g. octocat/hello-world)
**--schedule**="": cron schedule
**--server, -s**="": server address
**--token, -t**="": server auth token
### rm
remove a cron
**--id**="": cron id
**--log-level**="": set logging level (default: info)
**--repository, --repo**="": repository name (e.g. octocat/hello-world)
**--server, -s**="": server address
**--token, -t**="": server auth token
### update
update a cron
**--branch**="": cron branch
**--id**="": cron id
**--log-level**="": set logging level (default: info)
**--name**="": cron name
**--repository, --repo**="": repository name (e.g. octocat/hello-world)
**--schedule**="": cron schedule
**--server, -s**="": server address
**--token, -t**="": server auth token
### info
display cron info
**--id**="": cron id
**--log-level**="": set logging level (default: info)
**--repository, --repo**="": repository name (e.g. octocat/hello-world)
**--server, -s**="": server address
**--token, -t**="": server auth token
### ls
list registries
**--log-level**="": set logging level (default: info)
**--repository, --repo**="": repository name (e.g. octocat/hello-world)
**--server, -s**="": server address
**--token, -t**="": server auth token