Developing with packages from private registries and repositories
Packages, reusable pieces of software, help you build and reduce development time. Sometimes, the packages for your application must be installed from an external private registry or one hosted by your organization. Registries help you manage your code and dependencies. Codewind supports two private registry types: NPM registries for Node.js projects and Maven repositories for Java projects.
Developing with packages from private NPM registries
- Configure your local system to access the private registry. To do this, add the registry configuration and credentials to your profile’s
.npmrc
file. For more information, refer to the NPM documentation. Note: you should not put the.npmrc
file inside your project as it contains sensitive data. - Add a reference to the
.npmrc
file in your project. - Install packages from the configured registry to your project locally (e.g.
npm install @myorg/mypackage
). When Codewind builds the Docker image for your application, it pulls down the packages from the private registry you have configured.
Developing with packages from private Maven repositories
- Configure your local system to access the private repository. To do this, add the repository server credentials to your profile’s
settings.xml
file. For more information, refer to the Maven documentation. Note: you should not put thesettings.xml
file inside your project as it contains sensitive data. - Add a reference to the
settings.xml
file in your project. - Modify your
pom.xml
file, add the appropriate configuration to your<repositories>
/<pluginRepositories>
, then add the packages your application requires to your<dependencies>
references. When Codewind builds the Docker image for your application, it pulls down the packages from the private repository you have configured.
Supported project types
You can apply all the preceding instructions to these project types:
- Lagom Java
- Node.js Express
- Open Liberty
- Spring Boot
- WebSphere Liberty MicroProfile
Last update: Jun 19, 2020