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.
Connection
| What | This provider |
|---|---|
| Vendor | CircleCI |
| Key | circleci-project-envvars |
| Availability | available. You can connect it today. |
| Credential we hold | circleci-token |
| Values read back | no |
| Activation | immediate |
Directions
| Direction | What it does |
|---|---|
export | We write names and values from your environment into the store. |
CircleCI returns no value once it holds one, so we can write here and cannot read back.
Activation
immediate. The running app sees a new value at once.
Conflict policies
| Direction | Policies you can pick |
|---|---|
export | create_only, overwrite |
How syncs work says what each one does.
Connect
Paste a credential from the vendor. We seal it and never show it again.
| Field | Label | Kind | Required | What it is |
|---|---|---|---|---|
token | Personal API token | secret; we mask it here and seal it | yes | Must be a personal token. A project token is refused by CircleCI's v2 API. |
Mapping fields
You answer these 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. |
Required permissions
We probe for these when we verify 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. |