release-drafter VS ESLint

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

ESLint: A pluggable and configurable linter tool for identifying and reporting on patterns in JavaScript.

Automating code checks with static code analysis allows us to enforce code styling effectively. By integrating tools into our workflow, we can identify errors at an early stage, while coding instead of blocking us at the end. For instance, flake8 checks Python code for style and errors, eslint performs similar checks for JavaScript, and prettier automatically formats code to maintain consistency.

If you're a developer, you're surely familiar with Prettier and ESLint. With over 8 years of existence, they have established themselves as references in the JavaScript ecosystem.

eslint is used to avoid code errors

No lint errors: The committed code does not contain any lint errors (eslint).

Let’s walk through the steps for a one-time setup to configure husky pre-commit and pre-push hooks, ESLint with code styles conventions, prettier code formatter, and lint-staged. Husky automatically runs a script on each commit or push. This is useful for linting files to enforce code styles that keeps the entire code base following conventions.

GitHub | Website

ESLint: A pluggable and configurable linter tool for identifying and reporting on patterns in JavaScript.

ESLint

1. Lack of Static Code Analysis Static code analysis tools like TypeScript and ESLint play a crucial role in identifying and preventing bugs. TypeScript provides static typing, enhancing the robustness of the code. ESLint detects issues and enforces coding standards. The absence of these tools can significantly elevate the likelihood of bugs due to the lack of early detection and guidance provided during development.