Add Release Drafter to generate the changelog

[leouieda]

This Github Action automatically generates a changelog based on pull requests merged. The .github/workflows/release-drafter.yml sets up the workflow and .github/release-drafter.yml configures the generated changelog. A caveat is that the names of contributors is given only as their Github handle and not the full names (which we were using before). This is a minor sacrifice that I'm willing to make.

Fixes #86

Reminders:

• [ ] Run make format and make check to make sure the code follows the style guide.
• [ ] Add tests for new features or tests that would have caught the bug that you're fixing.
• [ ] Add new public functions/methods/classes to doc/api/index.rst and the base __init__.py file for the package.
• [ ] Write detailed docstrings for all functions/classes/methods. It often helps to design better code if you write the docstrings first.
• [ ] If adding new functionality, add an example to the docstring, gallery, and/or tutorials.
• [ ] If adding new example, please build the docs with make -C doc gallery and push the changes made on doc/gallery. Continuous Integration services build and deploy the docs, but they won't run the examples.
• [ ] Add your full name, affiliation, and ORCID (optional) to the AUTHORS.md file (if you haven't already) in case you'd like to be listed as an author on the Zenodo archive of the next release.

Reminders for Maintainers:

• [ ] Maintainers must run all tests locally before the PR is merged. CIs run only minimal tests and styling checks.

[leouieda]

The template configuration can be set for the whole organization by putting it in the .github repository. We can move this there after we test it out here to avoid having it duplicated across projects.

[leouieda]

Do we really just have to place these files in here? Or is there another step to enable the Action?

[santisoler]

Do we really just have to place these files in here? Or is there another step to enable the Action?

The times I have used GitHub Actions I've done it through the GitHub interface. But I think that it just adds files to .github/workflows and then if they exists, the CI run.

The template configuration can be set for the whole organization by putting it in the .github repository. We can move this there after we test it out here to avoid having it duplicated across projects.

Sure! According to GitHub docs, it should work for every Fatiando repo.

[leouieda]

It seems to be running but I'm getting an error on the configuration file. Not sure why it's complaining though. Maybe because it's running on a branch? Can you spot anything wrong with the configuration rile?

[santisoler]

It seems to be running but I'm getting an error on the configuration file. Not sure why it's complaining though. Maybe because it's running on a branch? Can you spot anything wrong with the configuration rile?

Probably it's looking for a .github/release-draft.yml with the template property on master... BTW, don't know if we should let it run on every branch or only on master. Is the Release Draft modified if we run Release Drafter from a non-master branch?

[leouieda]

I don't know. I just enbled this branch to test the configuration. I think it's safe to remove it and then merge this PR. Then we'll see if things worked or not :man_shrugging:

[leouieda]

:crossed_fingers: alright, let's see if we're lucky!