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, select the Development Package tool.

    Result: A table with existing development packages is shown.

  2. Select Create.

    Result: The Create Package dialog opens.

  3. In Name, enter a meaningful name for the development package.

    Result: You start in the General tab of the development package.

  4. In Description, enter a meaningful description for the development package.

  5. Select Save.

Optional additional steps to integrate with Git

  1. Create an empty repository in your preferred Git hosting solution. In this example, we use GitHub. When you have created an empty repository, copy the URL from the repository and add it to the development package.

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

    development package auth
  3. Select OK.

    Result: The Remote Repository dialog for Git connection opens.

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

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

    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 by selecting OK.

  7. To exclude default template files that are automatically included when pushing development package data to the connected Git repository, select Exclude Template Files.

  8. Select Save.

Results

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