BUILD.md

Building Java Keep-A-Changelog Updater

Inhaltsverzeichnis

• Prerequisites
• Build the Source Code
• Docker
  • Building the Docker Image

Prerequisites

• Java Development Kit (JDK) 17 or higher
• Maven
• Docker (optional, for running in a containerized environment)

Build the Source Code

To use the source code directly, follow these steps:

1. Ensure you have all prerequisites installed.
2. Clone the repository:

   git clone https://github.com/kirbylink/java-keep-a-changelog-updater.git
   cd java-keep-a-changelog-updater

3. Build the project using Maven:

   mvn clean verify

   Or to skip the tests during the build:

   mvn clean package -Dmaven.test.skip=true

4. Run the application:

   java -jar target/keep-a-changelog-updater-2.0.3-jar-with-dependencies.jar

Docker

Building the Docker Image

To build the Docker image, you can use the provided Dockerfile in the root directory of the project. Run the following command to build the image:

docker build -t java-keep-a-changelog-updater .