-
Notifications
You must be signed in to change notification settings - Fork 4.2k
feat: adds circleci to trust command #8909
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.
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
Merged
+706
−2
Merged
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
8adca94
feat: adds circleci to trust command
owlstronaut b8fd5d5
use full claim for body
owlstronaut bee9a6f
don't redact UUIDs for create/list trust commands
owlstronaut 967dbdd
make circleci pattern match gitlab/gha
owlstronaut 1a0ab04
add an error for including a protocol in vcs origin
owlstronaut c8278c4
add circleci to list body command
owlstronaut File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,179 @@ | ||
| const Definition = require('@npmcli/config/lib/definitions/definition.js') | ||
| const globalDefinitions = require('@npmcli/config/lib/definitions/definitions.js') | ||
| const TrustCommand = require('../../trust-cmd.js') | ||
|
|
||
| // UUID validation regex | ||
| const UUID_REGEX = /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/i | ||
|
|
||
| class TrustCircleCI extends TrustCommand { | ||
| static description = 'Create a trusted relationship between a package and CircleCI' | ||
| static name = 'circleci' | ||
| static positionals = 1 // expects at most 1 positional (package name) | ||
| static providerName = 'CircleCI' | ||
| static providerEntity = 'CircleCI pipeline' | ||
|
|
||
| static usage = [ | ||
| '[package] --org-id <uuid> --project-id <uuid> --pipeline-definition-id <uuid> --vcs-origin <origin> [--context-id <uuid>...] [-y|--yes]', | ||
| ] | ||
|
|
||
| static definitions = [ | ||
| new Definition('org-id', { | ||
| default: null, | ||
| type: String, | ||
| required: true, | ||
| description: 'CircleCI organization UUID', | ||
| }), | ||
| new Definition('project-id', { | ||
| default: null, | ||
| type: String, | ||
| required: true, | ||
| description: 'CircleCI project UUID', | ||
| }), | ||
| new Definition('pipeline-definition-id', { | ||
| default: null, | ||
| type: String, | ||
| required: true, | ||
| description: 'CircleCI pipeline definition UUID', | ||
| }), | ||
| new Definition('vcs-origin', { | ||
| default: null, | ||
| type: String, | ||
| required: true, | ||
| description: "CircleCI repository origin in format 'provider/owner/repo'", | ||
| }), | ||
| new Definition('context-id', { | ||
| default: null, | ||
| type: [null, String, Array], | ||
| description: 'CircleCI context UUID to match', | ||
| }), | ||
| // globals are alphabetical | ||
| globalDefinitions['dry-run'], | ||
| globalDefinitions.json, | ||
| globalDefinitions.registry, | ||
| globalDefinitions.yes, | ||
| ] | ||
|
|
||
| validateUuid (value, fieldName) { | ||
| if (!UUID_REGEX.test(value)) { | ||
| throw new Error(`${fieldName} must be a valid UUID`) | ||
| } | ||
| } | ||
|
|
||
| validateVcsOrigin (value) { | ||
| // Expected format: provider/owner/repo (e.g., github.com/owner/repo, bitbucket.org/owner/repo) | ||
| if (value.includes('://')) { | ||
| throw new Error("vcs-origin must not include a scheme (e.g., use 'github.com/owner/repo' not 'https://github.com/owner/repo')") | ||
| } | ||
| const parts = value.split('/') | ||
| if (parts.length < 3) { | ||
| throw new Error("vcs-origin must be in format 'provider/owner/repo'") | ||
| } | ||
owlstronaut marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| } | ||
|
|
||
| // Generate a URL from vcs-origin (e.g., github.com/npm/repo -> https://github.com/npm/repo) | ||
| getVcsOriginUrl (vcsOrigin) { | ||
| if (!vcsOrigin) { | ||
| return null | ||
| } | ||
| // vcs-origin format: github.com/owner/repo or bitbucket.org/owner/repo | ||
| return `https://${vcsOrigin}` | ||
| } | ||
|
|
||
| static optionsToBody (options) { | ||
| const { orgId, projectId, pipelineDefinitionId, vcsOrigin, contextIds } = options | ||
| const trustConfig = { | ||
| type: 'circleci', | ||
| claims: { | ||
| 'oidc.circleci.com/org-id': orgId, | ||
| 'oidc.circleci.com/project-id': projectId, | ||
| 'oidc.circleci.com/pipeline-definition-id': pipelineDefinitionId, | ||
| 'oidc.circleci.com/vcs-origin': vcsOrigin, | ||
| }, | ||
| } | ||
| if (contextIds && contextIds.length > 0) { | ||
| trustConfig.claims['oidc.circleci.com/context-ids'] = contextIds | ||
| } | ||
| return trustConfig | ||
| } | ||
|
|
||
| static bodyToOptions (body) { | ||
| return { | ||
| ...(body.id) && { id: body.id }, | ||
| ...(body.type) && { type: body.type }, | ||
| ...(body.claims?.['oidc.circleci.com/org-id']) && { orgId: body.claims['oidc.circleci.com/org-id'] }, | ||
| ...(body.claims?.['oidc.circleci.com/project-id']) && { projectId: body.claims['oidc.circleci.com/project-id'] }, | ||
| ...(body.claims?.['oidc.circleci.com/pipeline-definition-id']) && { | ||
| pipelineDefinitionId: body.claims['oidc.circleci.com/pipeline-definition-id'], | ||
| }, | ||
| ...(body.claims?.['oidc.circleci.com/vcs-origin']) && { vcsOrigin: body.claims['oidc.circleci.com/vcs-origin'] }, | ||
| ...(body.claims?.['oidc.circleci.com/context-ids']) && { contextIds: body.claims['oidc.circleci.com/context-ids'] }, | ||
| } | ||
| } | ||
|
|
||
| // Override flagsToOptions since CircleCI doesn't use file/entity pattern | ||
| async flagsToOptions ({ positionalArgs, flags }) { | ||
| const content = await this.optionalPkgJson() | ||
| const pkgName = positionalArgs[0] || content.name | ||
|
|
||
| if (!pkgName) { | ||
| throw new Error('Package name must be specified either as an argument or in package.json file') | ||
| } | ||
|
|
||
| const orgId = flags['org-id'] | ||
| const projectId = flags['project-id'] | ||
| const pipelineDefinitionId = flags['pipeline-definition-id'] | ||
| const vcsOrigin = flags['vcs-origin'] | ||
| const contextIds = flags['context-id'] | ||
|
|
||
| // Validate required flags | ||
| if (!orgId) { | ||
| throw new Error('org-id is required') | ||
| } | ||
| if (!projectId) { | ||
| throw new Error('project-id is required') | ||
| } | ||
| if (!pipelineDefinitionId) { | ||
| throw new Error('pipeline-definition-id is required') | ||
| } | ||
| if (!vcsOrigin) { | ||
| throw new Error('vcs-origin is required') | ||
| } | ||
|
|
||
| // Validate formats | ||
| this.validateUuid(orgId, 'org-id') | ||
| this.validateUuid(projectId, 'project-id') | ||
| this.validateUuid(pipelineDefinitionId, 'pipeline-definition-id') | ||
| this.validateVcsOrigin(vcsOrigin) | ||
| if (contextIds?.length > 0) { | ||
| for (const contextId of contextIds) { | ||
| this.validateUuid(contextId, 'context-id') | ||
| } | ||
| } | ||
|
|
||
| return { | ||
| values: { | ||
| package: pkgName, | ||
| orgId, | ||
| projectId, | ||
| pipelineDefinitionId, | ||
| vcsOrigin, | ||
| ...(contextIds?.length > 0 && { contextIds }), | ||
| }, | ||
| fromPackageJson: {}, | ||
| warnings: [], | ||
| urls: { | ||
| package: this.getFrontendUrl({ pkgName }), | ||
| vcsOrigin: this.getVcsOriginUrl(vcsOrigin), | ||
| }, | ||
| } | ||
| } | ||
|
|
||
| async exec (positionalArgs, flags) { | ||
| await this.createConfigCommand({ | ||
| positionalArgs, | ||
| flags, | ||
| }) | ||
| } | ||
| } | ||
|
|
||
| module.exports = TrustCircleCI | ||
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -139,6 +139,7 @@ Array [ | |
| String( | ||
| github | ||
| gitlab | ||
| circleci | ||
| list | ||
| revoke | ||
| ), | ||
|
|
||
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
Oops, something went wrong.
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.