Reference
CircleCI project environment variables
Variables set on one project rather than a shared context.
Variables set on one project rather than a shared context.
The connection
| What | This provider |
|---|---|
| Vendor | CircleCI |
| Key | circleci-project-envvars |
| Availability | available. You can connect it today. |
| Credential penv holds | circleci-token |
| Values read back | no |
| Activation | immediate |
What it moves
| Direction | What it does |
|---|---|
export | Writes names and values from penv into the store. |
CircleCI returns no value once it holds one, so penv can write here and cannot read back.
When a written value goes live
immediate. The running app sees a new value at once.
What happens to a name that exists
| Direction | Policies you can pick |
|---|---|
export | create_only, overwrite |
How syncs work says what each one does.
How you connect
You paste a credential you already hold. penv seals it and never shows it again.
| Field | Label | Kind | Required | What it is |
|---|---|---|---|---|
token | Personal API token | secret, masked here and sealed | yes | Must be a personal token. A project token is refused by CircleCI's v2 API. |
What a mapping asks for
Answered once per environment you map.
| Field | Label | Kind | Required | Advanced | What it is |
|---|---|---|---|---|---|
projectSlug | Project | text | yes | no | The vcs/org/repo slug from your CircleCI project URL. |
Permissions it needs
penv probes for these when it verifies the connection.
| Permission | Directions | Blocking | Without it |
|---|---|---|---|
me:read | every direction | yes | We cannot confirm which CircleCI account this token belongs to. |
project:write | export | yes | Export cannot write anything. |