Skip to content

docs: clarify CircleCI Personal API token setup #831

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.

Sign up for GitHub

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

Open
TOGEP wants to merge 1 commit into
base: main
Choose a base branch
from
+5 −4
Open

docs: clarify CircleCI Personal API token setup #831

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
9 changes: 5 additions & 4 deletions docs/Configuration/CircleCI.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,10 @@ For CircleCI, you do not need to enter the REST API endpoint URL, which is alway

#### Token

Learn about [Managing API Tokens](https://circleci.com/docs/managing-api-tokens/).

Tokens you have generated that can be used to access the CircleCI API. Apps using these tokens can act as you and have full read- and write-permissions!
There are two types of API token(Personal and Project) you can create within CircleCI.
Create a [CircleCI Personal API Token](https://circleci.com/docs/managing-api-tokens/#create-a-personal-api-token) for DevLake.

Use a token from a CircleCI user who can access the organization and projects you want to collect.
For SSO-enabled organizations, see CircleCI's [Personal API tokens with SSO](https://circleci.com/docs/guides/permissions-authentication/sso-overview/#personal-api-tokens-with-sso).

#### Proxy URL (Optional)

Expand All @@ -52,6 +51,8 @@ Click `Test Connection`, if the connection is successful, click `Save Connection

Select the CircleCI projects to collect.

DevLake can only detect projects that you follow in CircleCI.

@TOGEP TOGEP Jul 6, 2026 •
edited
Loading

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is not directly related to the token type clarification,
but Ilearned from #8634 that CircleCI projects need to be followed by the token owner before they can be discovered in DevLake.

I included this small note here as a related documentation improvement.


### Step 1.3 - Adding Scope Config (Optional)
Scope config includes two sets of configurations:
- Data Entities
Expand Down