Dart
Create a Dart registry, generate an identity token, then publish and install Dart or Flutter packages using the Dart pub protocol.
Use a Dart registry to host private Dart and Flutter packages, resolved using the Dart pub protocol.
What you will learn from this topic
By the end of this quickstart guide, you will be able to:
Create a registry in Harness Artifacts.
Publish a package to the registry.
Install the package from the registry, and confirm that it works.
Before you begin
Install the Dart CLI (
dart) or the Flutter CLI (flutter) on your local machine.Install the Harness CLI (
hc). You use it to publish packages to your registry.Make sure you have access to a Harness account with permission to create registries and connectors.
Create a Dart registry
To create a Dart registry, perform the following steps:
In Artifact Registry, select Registries.
Select + Create Registry.
Specify the Registry name.
Optionally, add a Description.
Choose visibility between Public and Private. The default is Private.
Select Dart as the Registry type.
Click Save.
Select Create to finalize.
Configure an upstream proxy (optional)
An upstream proxy allows your registry to fetch Dart packages from external sources when they are not available locally. The default upstream is pub.dev.
Create upstream proxy
To create an upstream proxy, perform the following steps:
In Artifact Registry, select Registries.
Select the drop-down next to + Create Registry and select Upstream Proxy.
Specify the Registry name.
Optionally, add a Description.
Choose visibility between Public and Private. The default is Private.
Select Dart as the Registry type.
Select the Source: Pub.dev or Custom.
If you select Custom, specify the Remote registry URL (for example,
https://pub.dev).
Select the Authentication method.
Username and password: Specify the username and password. Use an existing secret, or create a new secret by specifying the Name and entering the Secret text.
Anonymous: No credentials required. This works for public Dart registries such as pub.dev.
Select Create to finalize.
Configure the upstream proxy in your registry
To configure the upstream proxy in your registry, perform the following steps:
In Artifact Registry, select an existing Dart registry.
Navigate to the Configuration tab.
Select Edit in the Upstream proxy section.
Click + Add upstream proxy.
Select the required proxy from the list.
Click Apply.
Select Update to finalize.
Dart client setup
In your Dart Artifact, select the registry, then select Set Up Client. The dialog gives you an identity token, then setup instructions for the Dart CLI or the Flutter CLI.
Generate an identity token
An identity token serves as the password for authenticating with the registry.
In your Dart Artifact, select Set Up Client.
Select Generate Token.
Select an Expiration for the token:
30 Days
90 Days
180 Days
Custom
Copy the token. You use it in the following steps in place of
<IDENTITY_TOKEN>.
Configure the client
Select Dart CLI or Flutter CLI for your client. In the code samples, replace the values in angle brackets with your own values.
1. Add the authentication token
Add the identity token to Dart pub:
Enter your <IDENTITY_TOKEN> when prompted.
2. Publish a package
In your package's pubspec.yaml, set the registry URL:
Then publish the package:
3. Install a package
In your consuming project's pubspec.yaml, add the dependency pointing to the hosted URL:
Then fetch it:
1. Add the authentication token
Add the identity token to Flutter pub:
Enter your <IDENTITY_TOKEN> when prompted.
2. Publish a package
In your package's pubspec.yaml, set the registry URL:
Then publish the package:
3. Install a package
In your consuming Flutter project's pubspec.yaml, add the dependency pointing to the hosted URL:
Then fetch it:
Setup verification
Confirm that your registry serves the package you published. To verify your setup, perform the following steps:
In a new directory with no packages in the local pub cache, use
dart pub getorflutter pub getto resolve the package you published.Confirm that the client downloaded the package from your Harness registry address, which is shown in Set Up Client.
In Harness, open your registry and confirm that the package and version appear in the package list.
If a step fails, go to Troubleshooting to resolve common authentication and resolution issues before you retry.
Pipeline automation (optional)
Publishing from a pipeline gives you a repeatable release process. Run the publish step when you create a version tag, so each release maps to one version in the registry.
The following Run step publishes a Dart package on every version tag. Store the identity token as a Harness secret, and do not write it into the pipeline YAML.
Troubleshooting
Next steps
To add a pipeline that publishes a new version for every release tag, go to Harness CI.
To control who can publish and consume packages in your registry, go to RBAC and permissions.
To set retention and lifecycle rules for old versions, go to Lifecycle Management overview.
Last updated
Was this helpful?