HOWTO-generate-the-changelog.md

Go to the documentation of this file.

# Requirements

## [gitlab_awesome_release](https://gitlab.com/sue445/gitlab_awesome_release)

You can install using gem

```sh
gem install gitlab_awesome_release
```

You need a token because Gitlab doesn't accept more than a certain number of requests per minute (should be 10).

# Generate the CHANGELOG.md

```
export GITLAB_API_PRIVATE_TOKEN="YOUR GITLAB PRIVATE TOKEN"
export GITLAB_API_ENDPOINT="http://gitlab.com/api/v4"
export GITLAB_PROJECT_NAME="Remmina/Remmina"
gitlab_awesome_release create_latest_note --filename=CHANGELOG.1.4.10.md
```

Than use the newly created note to update the file [CHANGELOG.md](https://gitlab.com/Remmina/Remmina/-/blob/master/CHANGELOG.md)

# Commit the new CHANGELOG.md

The CHANGELOG.md should be committed only during a new release.