Rodrigo Machado
Rodrigo Machado
The `fmt` command formats and normalizes the changelog file. But to check if the file is formatted correctly, we need to run something similar to: ```shell diff -u
As now we have a proper docker image published in Docker Hub (https://hub.docker.com/r/rcmachado/changelog), it's worth mentioning it in the documentation along with instructions on how to use it.
As now we have an official [Docker image](https://hub.docker.com/r/rcmachado/changelog), we can easily have a GitHub Action. The action can be used to: - Ensure the CHANGELOG.md file is properly formatted (`fmt`)...
It would be nice to have an interactive mode, where just typing `changelog` would bring a menu with options: ```bash $ changelog Choose an option 1. Initialize a new file...
Add a `lint` command that could educate about best practices regarding changelog messages. One easy win would be checking for `Add ...`, `Fix ...`, `Remove ...` kind of messages in...
We shouldn't fail test steps if `COVERALLS_TOKEN` is missing (which happens in forks). See #58. We should gracefully detect this or at least don't fail the `tests` job.
Document properly how to release a new version. Currently the process is: - Add a new version to CHANGELOG.md (could be done with the tool) - Create a git tag...
Currently our documentation is very basic - only the README - and doesn't cover all commands nor provide much examples. We need to improve this so it's easier for someone...
When running the `changelog` command we can detect and build the compare URL based on previous versions already specified in the markdown file. But if we have a brand new...
Internally, `changelog` current has the following structs: - `Changelog`: the whole changelog data - `Version`: represents each version - `ChangeType`: `Added`, `Changed`, etc. - `ChangeList`: messages for a given "section"...