Page Comparison

Appanvil karma designer

summary

Awesome automationWe use GitHub actions to make sure our code is always first-rate. We have put together a set of actions so you don't have to. These should be applied to all new projects and are slowly being added to our older projects. Just give in to your robot overlords and life will be much easier. 🤖 To get started, check out the GitHub action documentation Before you startThere are a few bits and bobs it's worth knowing about before diving into our actions. Firstly, most of the actions rely on you having other files. You will find a set of template files in the .github repo that should cover all the bases, but it is on the developer to make sure that they edit the templates where required to meet the requirements of the project.You should also be aware of our expectations around things like committing, testing and code structure. If you add these actions to a repo that isn't already compliant, you are going to have a bad time. As a minimum, before adding any of these actions, you should grab the tox file and run it against your code. This should highlight the vast majority of issues, but not all of them.Some of the actions require some initial setup steps on GitHub or PyPI. You will need to know about using secrets in GitHub actions and about authenticating with GitHub app generated tokens. Thankfully, the heavy lifting has been done, and you just need to add your repo to the app and the secrets to your repo. .github repoAll our actions can be found on our organisation's GitHub instance. As a bonus, you will also find a set of template files for tox and the README. Take a Look Conventional PR TitleThis action check that the title of any pull request is consistent with the conventional commits specification. Don't know what that is? Have a read of the docs Take a Look File CheckThis action checks to make sure that you have all the expected files. A wise man once said an empty README is worse than no README. Lucky, this action checks for both. It also makes sure your project has a CHANGELOG, licence, tox file and project.toml. Take a Look PublishThe publish workflow uses poetry to build a distribution and then use trusted publishing to publish to PyPI. You will need to set up trusted publishing on any project that you wish to apply this action to. Luckily, it's super quick. It probably goes without saying, but I will say it just in case, you only need to apply this to repos that would be classed as packages.To run this action, you will need help from my trusty workflow runner bot, Ren 🤖. He is super awesome at running actions for you, which isn't possible from actions itself, because you could end up in an accidental recursive workflow run. ☠️ Take a Look ReleaseIf, like me, you hate filling in changelogs and tagging releases on GitHub, this action is for you. This action relies on conventional commits to generate an amazing CHANGELOG and to automatically open a release branch. It uses Release Please Action which is made by google so you know it's going to be good. They recommend using squash merging and so do I, it's magic for your commit history. Take a Look TestThis runs the tox script against your code. That's it..... oh no wait I forgot about TODO's, it also checks to make sure they conform to our expectation around those. Take a Look ExtrasAs mentioned elsewhere, you can also find templates for all the other standard stuff we expect to find in our repos. Take a Look Automatic PR'sEver wondered what happens to developers when they snap? Check out the automatic PR action for a glimps into your future. Do not apply this to any repos unless you are very sure you know what you are doing. This is super experimental and likely to blow up if handled incorrectly. 💣💥🤯 Take a Look

page

Version	Old Version 4	New Version Current
Changes made by	Andrew Atterton	Andrew Atterton
Saved on	Apr 10, 2024	Apr 10, 2024

Versions Compared

Key