IPM
Introduction
The released packages provide versioning support, facilitate exploration of version history, demonstrate examples and READMEs, and include additional functionalities. It is strongly advised to deploy reusable packages to a hub.
When utilizing the IPM client to publish new versions to the IPM, it enables the creation of public, hybrid and packages. This functionality also permits the building of applications from a designated folder.
Requirements
Everyone can publish packages to our hub. In our free tier you have to comply with the following requirements and guidelines:
Naming conventions
Please use a names that is meaningful to the content of your package. The following rules apply to all packages:
- May only contains a-z 0-9 -(dash) and _ (underscores)
- Max 36 chars
Tagging
We use Git tags to version your packages. A valid tag is a semantic tag like x.y.z, for example 1.2.3 or 0.1.23. We currently do not support pre or suffixes.
Publish
Getting you package published in the hub consists of two main tasks.
Create package
Before, you can upload a new versions. You first need to create a package at IPMHub.
-
Sign in to Portal IPMHub
-
There are multiple locations that will lead you to the add package page.
Click the image to enlarge
Click the image to enlarge
-
Press the green button with the name “create package”, which can be found in the box with a name: “Publish using IPM”
Click the image to enlarge
-
Fill in the form.
Package name
- The name of your packagePackage description
- Provide a description of your package. This information is visible in the search results and theIPM
cli clientProject URL
- Optional, you provide an link for this project, for example to you docs site or home page.Package type
- The type of package it is.Description language
- In what language is the description written. Knowing the right language makes sure it’s translated properlyLicense
- Under which license to you publish the package.Package Visibility
- Choose how your package will be visible to other users. (More information about visibility)
Click the image to enlarge
-
Click the
Review
. -
Confirm the values and create the package.
Click the image to enlarge
Upload new versions
Once you have successfully created the package on IPMHub, you can initiate the process of publishing your new versions using our clients. For detailed information about the publish parameter, please check this page . It is important to note that you must have a valid session in place before you can proceed to upload new versions.
A few Example: Publish a package with the contents of the current folder. (Linux)
ipm publish --package ipmhub/hello-world --version 1.0.0 --folder ./
Publish a package with the content stored in another folder relative to the current directory (Linux)
ipm publish --package ipmhub/hello-world --version 1.0.0 --folder ./staging