release-drafter VS cookietemple

For releasing or publishing our code automatically, we will use the action Release Drafter

New release drafts are triggered after every commit is pushed to the main staging build. The drafted release (built with release drafter) will contain all the commits added since the previous release and a suggested new version which will follow the Semantic Versioning rules.

I am thinking I would have to create a GitHub release manually and then have a workflow listening on the "Release created" event, which would pull the image with the correct commit sha, tag it with the proper version and push it. Or using something like Release Drafter with a PR-based Git flow.

During 2021, we worked hard to improve it furthermore and add new functionality. We just released the latest version of cookietemple. It now includes (beside other templates for example an advanced C++ template or a Java CLI template) a modern python template using poetry, nox (nox-poetry), automatic docs setup as well as many cool and modern GitHub actions, like ReleaseDrafter (https://github.com/release-drafter/release-drafter).

Every commit pushed to the main branch will trigger a staging build. In addition to this, every commit pushed to the main branch will draft a new release on GitHub with the help of the release drafter.

We are always actively working on the configuration for Renovate and will continue to fine-tune it. Having pull requests created for every upstream version change will also optimise the generation of automated changelogs (using the excellent Release Drafter GitHub Action we were already using on Lagoon).

I wanted to provide a way to be able to easily create release notes, to enhance transparency on what we are delivering. I chose to use a tool called Release Drafter in our workflow. I wanted to configure how labels would be used in every repository, and for that, we standardised all labels across all repositories. I use: docs, dependencies, bug, feature, and maintenance.

release-drafter / release-drafter

For structure, project setup and getting an idea of how to "style" a project by following best practices, you could take a look at https://github.com/cookiejar/cookietemple. (Disclaimer: I'm one of its authors).

It really depends on how you plan to use your projects: Is it for personal use only? Do you want to use it as a cli application or a standalone package or just some loose script collection? If you want to get an idea of how to structure bigger projects, I recommend you to take a look at https://github.com/cookiejar/cookietemple. (Disclaimer: I'm one of its developers). The cli-python template there should give you a good idea of how a project could actually look like.

In 2020, we did the first release of cookietemple (PyPi: https://pypi.org/project/cookietemple/, GitHub: https://github.com/cookiejar/cookietemple).

The c++ template of https://github.com/cookiejar/cookietemple might be useful to you.

If you're willing to write a cookiecutter version it would be awesome to have it in https://github.com/cookiejar/cookietemple

You could create a project with https://github.com/cookiejar/cookietemple and attempt to understand the structure.

Hey, the post was a nice read ;). As you mentioned cookiecutter, you might also want to take a look at cookietemple (Disclaimer: I'm one of the authors of this project). It is basically designed exactly for this purpose: Setup a modern (python) project with everything needed to start developing in seconds with as much automating of this process as possible.

Cookiecutter is an amazing tool for templating! This could have aided you a lot. I suggest that you check out https://github.com/cookiejar/cookietemple for a Python templates which goes a lot of steps beyond yours for some inspiration. You can always contribute ;)

And if you are looking for an excellent template (collection) you guys should look at https://github.com/cookiejar/cookietemple