docs: clarify CircleCI Personal API token setup#831
Open
TOGEP wants to merge 1 commit into
Open
Conversation
TOGEP
commented
Jul 6, 2026
|
|
||
| Select the CircleCI projects to collect. | ||
|
|
||
| DevLake can only detect projects that you follow in CircleCI. |
Author
There was a problem hiding this comment.
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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The DevLake CircleCI connector uses CircleCI API v2 endpoints for connection checks and data collection.
However, CircleCI's official documentation states that Project API Tokens are not supported for API v2.
https://circleci.com/docs/api/v1/#get-authenticated
Because the current wording could be interpreted as saying that Project API Tokens can also be used with DevLake,
this PR updates the CircleCI configuration docs to make it clear that DevLake expects a Personal API Token.
Does this close any open issues?
No related open issue found.
Screenshots
N/A
Other Information
/v2/me/v2/me/collaborations/v2/project/{slug}/v2/project/{slug}/pipeline/v2/pipeline/{id}/workflow/v2/workflow/{id}/v2/workflow/{id}/job