Add a new development package and integrate with Git

In this topic, you learn how to create a new development package. Development packages are meant to contain all artifacts for a solution built on Neptune DXP - Open Edition.

Prerequisites

  • If you are going to integrate with GitHub, an account will need to exist there, with a repository created.

Procedure

  1. In the Cockpit, go to Development and select Development Package.

    Result: A table with all packages opens.

  2. Select Add.

    Result: A new window opens.

  3. Enter a Name and a Description for the package.

  4. Select Save.

(Optional additional steps to integrate with Git)

  1. Create an empty repository in your preferred Git hosting solution. In this document we will be using GitHub. When you have created an empty repository grab the URL to the repository and add it to the development package. A repository URL to GitHub will look something like the below URL: https://github.com/sveingunnarlarsen/com.neptune.testpackage.git

  2. In the Git and CI/CD section, first select Enable and then Update to configure the connection to a remote Git repository.

    development package auth
  3. Select OK.

    Result: The Git connection dialog opens.

  4. Enter the URL of the repository you wish to connect this package to.

  5. If the repository is private, select Configure authentication to set your personal authentication to the remote repository.

    Result: The Authentication dialog opens.

    1. For authentication type Basic, enter your Username and Password.

    2. For authentication types GitHub, BitBucket, and GitLab, enter your personal access Token.

  6. Close both dialogs with Ok.

  7. Select Save.

Results

  • You have added a new development package that is linked to a GitHub repo.