Skip to main content

Release a Service

Tags:
🎯context

You have implemented changes in your Service and want to release them so that the new version could be used in an Application.

Description​

This How-To will cover how you can increase the version number of your project and trigger a release of the latest state. The instructions are working for both Domain service and Basic service projects.

Preconditions​

  • You have finished off your changes in the Solution Designer or in the implementation and pushed them successfully

Steps​

Increase version number​

Increasing the version number is a manual step that needs to be done within your IDE.

  1. Open the cloned project with your IDE.

    • for JavaScript / TypeScript projects
      Open the file package.json and find the version number in the field version

    • for Java projects
      Open the file pom.xml and find the version number in the field version

  3. Adjust the version number an set it to a higher value (e. g. adjust it from 1.0.0 to 1.0.1)

    ℹ️note

    It is recommended to use the Semantic Versioning approach when deciding for a new version number depending on the changes that are included in the release.

    💡tip

    During development, it is common practice to use a pre-release version number like 1.0.0-alpha. If you use this syntax, there is no need of updating the version number by hand to create a new release. However, for the production case a dedicated version number is recommended.

  4. Commit and push the changes to the GIT repository.

Release new version​

After updating the version number, the new release can be created.

  1. Open the CI/CD area of your project in the Solution Designer.

  2. Create the release with the help of a Release Pipeline.

    • Please create one by using the "Create" button in the pipeline configurations overview:
❗️info

If the pipeline fails, it might be that you have already created a release with the set version number beforehand. Please ensure that the version number has not been used so far.

🌟Congratulations!

After the pipeline run finished successfully, a new release of the Service has been created and is ready to be used in the Application.