Discuss automations

[wd60622]

Overview

In order to keep the project looking alive and well, I think some automations should be set in place for:

• Documentation Set up documentation automation  #780
• PyPI releases

There have been handful of PRs since the 0.48.9 release on PyPI and the documentation build is ~4 years old. It would be good to make sure people's PRs become displayed and available.

Solution

My proposed solution is to build out the GitHub Actions more. This would be an Action for:

• Documentation automation upload to readthedocs
• PyPI release

I suggest both of these get triggered by a GitHub Release so we can work in some additional benefits: The auto-generated release notes takes advantage of the PRs and their labels between tagged versions of the repo. I see this is a way to address #763 while keeping manually efforts low.

Once up and running, the only manual work require is

1. PRs be appropriately labeled (say enhancement / bug-fix / documentation to be simple)
2. make a release via GitHub when needed.

then the documentation updates and PyPI release would follow.

Missing Items

In order to complete some of these automation, there are some missing credentials and permissions. Namely,

• readthedocs credentials needed for Action
• PyPI credentials needed for Action
• GitHub permissions for the individual who makes the release and input the credentials above.

I can layout some additional details later if needed

Additional Enhancements

The manual PR labelling can mitigated by creating some PR templates. But it should be easy to bucket PRs into enhancements, bug-fixes, documentation change to be simple

Thoughts

I would appreciated to hear any thoughts on this solutions or if there are any missing details that people would want to know. @AzisK