Introduction

Welcome to the Changelog API documentation! This guide will help you understand how to use Changelog API

How-to guide

Set up CLI

Your system must have Python installed. If you don't have it, you can follow the instructions from Python downloads page. The next steps expect you to be in Linux/MacOS terminal.

  1. Create Python virtual environment

    python3 -m venv demo

  2. Activate the virtual environment

    source demo/bin/activate

  3. Install with pip

    python3 -m pip install changelog-api-client

  4. Try cli_project -h command for a list of available project management functionality

  5. Try changelog -h command for a list of available changelog functionality

Manage projects

The following is for CLI:

  1. Create a configuration file config.ini

                        [DEFAULT]
                    url = https://changelogapi.eu/app

  2. Set PROJECT_CLI_CONFIG_PATH configutation environment variable

    export PROJECT_CLI_CONFIG_PATH=config.ini

  3. Generate RSA private key

    openssl genpkey -algorithm RSA -out private_key.pem -pkeyopt rsa_keygen_bits:4096

  4. Extract the public key

    openssl rsa -pubout -in private_key.pem -out public_key.pem

  5. Create a project

    cli_project create demo-project public_key.pem private_key.pem

With cat config.ini you can see the created project's id and the key pair's id.

  1. When you no longer need the project, you can delete it

    cli_project delete

With cat config.ini you can see that the current project's record is no longer there.

Manage versions

The following is for CLI:

  1. Create a version

    changelog create-version 1.0.0

  2. Release a version. A release version is a finalized iteration of a software product that is made available to users.

    changelog release-version 1.0.0

  3. The read-versions command retrieves a list of available software versions. By default, it displays up to 5 versions per page. However, you can customize the number of versions shown by specifying your desired amount as an argument. This allows you to view more or fewer versions based on your needs.

    changelog read-versions

  4. Delete a version

    changelog delete-version 1.0.0

Manage changes

The following is for CLI:

  1. Create a change. It is important to choose the category of the change: added, changed, deprecated, removed, fixed, or security.

    changelog create-change 1.0.0 added "Implemented user authentication" "John Smith"

  2. Move a change

    changelog move-change 1.0.0 1.0.1 920eb6c1-b14d-424a-9d33-6e94fcc86bec

  3. Read changes

    changelog read-changes 1.0.1

  4. Delete a change

    changelog delete-change 1.0.1 920eb6c1-b14d-424a-9d33-6e94fcc86bec