-
Notifications
You must be signed in to change notification settings - Fork 129
CodeArtifact: Add documentation #1775
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
Open
skyrpex
wants to merge
10
commits into
main
Choose a base branch
from
codeartifact
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 7 commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
e6d9c1d
add codeartifact docs
skyrpex 9a9d46c
wip
skyrpex 0f05682
remove duplicated paragraph
skyrpex 1c3beea
style changes
skyrpex 6b7fa03
fix style
skyrpex b283031
style changes
skyrpex 736fe93
break some command examples for clarity
skyrpex 5a26c7c
Update content/en/user-guide/aws/codeartifact/index.md
skyrpex 378a2ea
Add "Using CodeArtifact with npm"
skyrpex 32821e7
Merge branch 'main' into codeartifact
skyrpex 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 |
---|---|---|
@@ -1,6 +1,7 @@ | ||
{ | ||
"cSpell.words": [ | ||
"awslocal", | ||
"codeartifact", | ||
"quickstart" | ||
] | ||
} |
14 changes: 14 additions & 0 deletions
14
content/en/references/coverage/coverage_codeartifact/index.md
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,14 @@ | ||
--- | ||
title: "CodeArtifact" | ||
linkTitle: "codeartifact" | ||
description: > | ||
Implementation details for API codeartifact | ||
hide_readingtime: true | ||
draft: true | ||
--- | ||
|
||
## Coverage Overview | ||
{{< localstack_coverage_table service="codeartifact" >}} | ||
|
||
## Testing Details | ||
{{< localstack_coverage_details service="codeartifact" >}} |
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,267 @@ | ||
--- | ||
title: CodeArtifact | ||
linkTitle: CodeArtifact | ||
description: > | ||
Get started with CodeArtifact on LocalStack | ||
tags: ["Pro image"] | ||
--- | ||
|
||
## Introduction | ||
|
||
CodeArtifact is a fully managed artifact repository service that makes it easy to securely store, publish, and share software packages used in your development process. | ||
|
||
On AWS, CodeArtifact supports common package formats such as Maven, npm, Python (pip), and NuGet. | ||
You can configure it to work with public repositories or use it to store your private packages. | ||
|
||
LocalStack provides mocking support for several CodeArtifact API operations. | ||
You can find supported operations on the [API coverage page]({{< ref "coverage_codeartifact" >}}). | ||
|
||
## Getting Started | ||
|
||
This guide will help you create a domain, repository, and manage package publishing workflows using the `awslocal` CLI. | ||
|
||
Basic knowledge of the AWS CLI and the [`awslocal`](https://github.com/localstack/awscli-local) wrapper is expected. | ||
|
||
Start LocalStack using your preferred method. | ||
|
||
### Domains | ||
|
||
Domains are the top-level containers for repositories in CodeArtifact. | ||
|
||
Create a domain with the [CreateDomain](https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_CreateDomain.html) operation: | ||
|
||
{{< command >}} | ||
$ awslocal codeartifact create-domain --domain demo-domain | ||
{{< /command >}} | ||
|
||
The following output is displayed: | ||
|
||
```json | ||
{ | ||
"domain": { | ||
"name": "demo-domain", | ||
"owner": "000000000000", | ||
"arn": "arn:aws:codeartifact:eu-central-1:000000000000:domain/demo-domain", | ||
"status": "Active", | ||
"createdTime": "2025-05-20T11:30:52.073202+02:00", | ||
"repositoryCount": 0, | ||
"assetSizeBytes": 0 | ||
} | ||
} | ||
``` | ||
|
||
You can use [DescribeDomain](https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_DescribeDomain.html), [UpdateDomain](https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_UpdateDomain.html), and [DeleteDomain](https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_DeleteDomain.html) for domain management. | ||
|
||
{{< command >}} | ||
$ awslocal codeartifact describe-domain --domain demo-domain | ||
{{< /command >}} | ||
|
||
The following output is displayed: | ||
|
||
```json | ||
{ | ||
"domain": { | ||
"name": "demo-domain", | ||
"owner": "000000000000", | ||
"arn": "arn:aws:codeartifact:eu-central-1:000000000000:domain/demo-domain", | ||
"status": "Active", | ||
"createdTime": "2025-05-20T11:30:52.073202+02:00", | ||
"repositoryCount": 0, | ||
"assetSizeBytes": 0 | ||
} | ||
} | ||
``` | ||
|
||
You can list all domains using [ListDomains](https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_ListDomains.html). | ||
|
||
{{< command >}} | ||
$ awslocal codeartifact list-domains | ||
{{< /command >}} | ||
|
||
The following output is displayed: | ||
|
||
```json | ||
{ | ||
"domains": [ | ||
{ | ||
"name": "demo-domain", | ||
"owner": "000000000000", | ||
"arn": "arn:aws:codeartifact:eu-central-1:000000000000:domain/demo-domain", | ||
"status": "Active", | ||
"createdTime": "2025-05-20T11:30:52.073202+02:00" | ||
} | ||
] | ||
} | ||
``` | ||
|
||
### Repositories | ||
|
||
Repositories store packages and are associated with a domain. | ||
|
||
Create a repository using [CreateRepository](https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_CreateRepository.html): | ||
|
||
{{< command >}} | ||
$ awslocal codeartifact create-repository --domain demo-domain \ | ||
--repository demo-repo | ||
{{< /command >}} | ||
|
||
The following output is displayed: | ||
|
||
```json | ||
{ | ||
"repository": { | ||
"name": "demo-repo", | ||
"administratorAccount": "000000000000", | ||
"domainName": "demo-domain", | ||
"domainOwner": "000000000000", | ||
"arn": "arn:aws:codeartifact:eu-central-1:000000000000:repository/demo-domain/demo-repo", | ||
"upstreams": [], | ||
"externalConnections": [], | ||
"createdTime": "2025-05-20T11:34:27.712367+02:00" | ||
} | ||
} | ||
``` | ||
|
||
You can use [DescribeRepository](https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_DescribeRepository.html), [UpdateRepository](https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_UpdateRepository.html), and [DeleteRepository](https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_DeleteRepository.html) to manage repositories. | ||
|
||
{{< command >}} | ||
$ awslocal codeartifact describe-repository --domain demo-domain \ | ||
--repository demo-repo | ||
{{< /command >}} | ||
|
||
The following output is displayed: | ||
|
||
```json | ||
{ | ||
"repository": { | ||
"name": "demo-repo", | ||
"administratorAccount": "000000000000", | ||
"domainName": "demo-domain", | ||
"domainOwner": "000000000000", | ||
"arn": "arn:aws:codeartifact:eu-central-1:000000000000:repository/demo-domain/demo-repo", | ||
"upstreams": [], | ||
"externalConnections": [], | ||
"createdTime": "2025-05-20T11:34:27.712367+02:00" | ||
} | ||
} | ||
``` | ||
|
||
Use [ListRepositories](https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_ListRepositories.html) to view all of the repositories. | ||
|
||
{{< command >}} | ||
$ awslocal codeartifact list-repositories | ||
{{< /command >}} | ||
|
||
The following output is displayed: | ||
|
||
```json | ||
{ | ||
"repositories": [ | ||
{ | ||
"name": "demo-repo", | ||
"administratorAccount": "000000000000", | ||
"domainName": "demo-domain", | ||
"domainOwner": "000000000000", | ||
"arn": "arn:aws:codeartifact:eu-central-1:000000000000:repository/demo-domain/demo-repo", | ||
"createdTime": "2025-05-20T11:34:27.712367+02:00" | ||
} | ||
] | ||
} | ||
``` | ||
|
||
Otherwise, list repositories in a specific domain using [ListRepositoriesInDomain](https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_ListRepositoriesInDomain.html): | ||
|
||
{{< command >}} | ||
$ awslocal codeartifact list-repositories-in-domain --domain demo-domain | ||
{{< /command >}} | ||
|
||
The following output is displayed: | ||
|
||
```json | ||
{ | ||
"repositories": [ | ||
{ | ||
"name": "demo-repo", | ||
"administratorAccount": "000000000000", | ||
"domainName": "demo-domain", | ||
"domainOwner": "000000000000", | ||
"arn": "arn:aws:codeartifact:eu-central-1:000000000000:repository/demo-domain/demo-repo", | ||
"createdTime": "2025-05-20T11:34:27.712367+02:00" | ||
} | ||
] | ||
} | ||
``` | ||
|
||
### External Connections and Upstream Repositories | ||
|
||
Repositories can be associated with external connections using [AssociateExternalConnection](https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_AssociateExternalConnection.html) and [DisassociateExternalConnection](https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_DisassociateExternalConnection.html). | ||
|
||
{{< command >}} | ||
$ awslocal codeartifact associate-external-connection --domain demo-domain \ | ||
--repository demo-repo \ | ||
--external-connection "public:npmjs" | ||
{{< /command >}} | ||
|
||
The following output is displayed: | ||
|
||
```json | ||
{ | ||
"repository": { | ||
"name": "demo-repo", | ||
"administratorAccount": "000000000000", | ||
"domainName": "demo-domain", | ||
"domainOwner": "000000000000", | ||
"arn": "arn:aws:codeartifact:eu-central-1:000000000000:repository/demo-domain/demo-repo", | ||
"upstreams": [], | ||
"externalConnections": [ | ||
{ | ||
"externalConnectionName": "public:npmjs", | ||
"packageFormat": "npm", | ||
"status": "AVAILABLE" | ||
} | ||
], | ||
"createdTime": "2025-05-20T14:03:27.539994+02:00" | ||
} | ||
} | ||
``` | ||
|
||
Alternatively, repositories can be configured with upstream repositories using the `upstreams` property of [CreateRepository](https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_CreateRepository.html) and [UpdateRepository](https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_UpdateRepository.html). | ||
|
||
{{< command >}} | ||
$ awslocal codeartifact create-repository --domain demo-domain \ | ||
--repository demo-repo2 \ | ||
--upstreams repositoryName=demo-repo | ||
{{< /command >}} | ||
|
||
The following output is displayed: | ||
|
||
```json | ||
{ | ||
"repository": { | ||
"name": "demo-repo2", | ||
"administratorAccount": "000000000000", | ||
"domainName": "demo-domain", | ||
"domainOwner": "000000000000", | ||
"arn": "arn:aws:codeartifact:eu-central-1:000000000000:repository/demo-domain/demo-repo2", | ||
"upstreams": [ | ||
{ | ||
"repositoryName": "demo-repo" | ||
} | ||
], | ||
"externalConnections": [], | ||
"createdTime": "2025-05-20T14:07:56.741333+02:00" | ||
} | ||
} | ||
``` | ||
|
||
{{< callout "note">}} | ||
Please note, a repository can have one or more upstream repositories, or an external connection. | ||
{{< /callout >}} | ||
|
||
## Current Limitations | ||
|
||
LocalStack doesn't support the following features yet: | ||
|
||
- Domain and repository permission policies | ||
- Packages and package groups handlers | ||
- Retrieving repository endpoints |
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.