Simplify local development setup #67

New Issue

Jef Roosens · 2021-05-05T18:38:16+02:00

Jef Roosens commented

2021-05-05 18:38:16 +02:00

This issue contains several tasks that will simplify the developer's environment and speed up development.

Integrate cargo-watch

Cargo-watch is basically Nodemon for Rust.

We can mount the codebase in the Docker container, and run cargo-watch inside the container. This will allow the developer to start up the container once, and see the updates happen as they implement them.

Stop building the builder

Instead of locally building the builder image, we could create it inside the CICD pipeline. This would ensure every developer has the same builder, and speed up their local environment by preventing unnecessary rebuilds.

One possible issue here might be the need for new features inside the builder, but we'll cross that bridge when we get there.

Remove format-checking Git hooks

Considering the CICD pipeline checks for formatting errors, we don't need to do this locally anymore. Instead, we can just set the develop branch to protected. This will ensure the develop branch stays clean, without slowing down the developing during work on an issue.

Simplify issue-number adding hook

Honestly, the hook annoys more than anything. Instead of adding anything to the commit message, the hook should only check wether or not an issue number is present, and error out if not.

This issue contains several tasks that will simplify the developer's environment and speed up development. - [ ] Integrate cargo-watch [Cargo-watch](https://github.com/passcod/cargo-watch) is basically Nodemon for Rust. We can mount the codebase in the Docker container, and run cargo-watch inside the container. This will allow the developer to start up the container once, and see the updates happen as they implement them. - [ ] Stop building the builder Instead of locally building the builder image, we could create it inside the CICD pipeline. This would ensure every developer has the same builder, and speed up their local environment by preventing unnecessary rebuilds. One possible issue here might be the need for new features inside the builder, but we'll cross that bridge when we get there. - [ ] Remove format-checking Git hooks Considering the CICD pipeline checks for formatting errors, we don't need to do this locally anymore. Instead, we can just set the `develop` branch to protected. This will ensure the `develop` branch stays clean, without slowing down the developing during work on an issue. - [ ] Simplify issue-number adding hook Honestly, the hook annoys more than anything. Instead of adding anything to the commit message, the hook should *only* check wether or not an issue number is present, and error out if not.

Jef Roosens added this to the Fej 1.1.0 - The Calm before the Storm milestone 2021-05-05 18:38:16 +02:00

Jef Roosens added the

enhancement

label 2021-05-05 18:38:17 +02:00

Jef Roosens self-assigned this 2021-05-05 18:38:17 +02:00

Jef Roosens added this to the Fej 1.1.0 project 2021-05-05 18:38:17 +02:00

Jef Roosens changed title from ~~Switch to cargo-watch~~ to Simplify local development setup

2021-05-10 17:08:09 +02:00

Jef Roosens added a new dependency 2021-05-10 17:10:59 +02:00

#45 Setup proper CICD pipeline

Sign in to join this conversation.