Update CI tooling and workflows #7
Conversation
There was a problem hiding this comment.
@jorgecuesta Thank you so much for this PR! I haven't had the opportunity to thoroughly review all the tooling in this repository yet, and it's fantastic to see community members advancing our toolset.
I've left a few questions in the review. Additionally, we need to remove the zip files from this branch before merging.
Unfortunately, there's no ideal way to test the workflows before merging, and I anticipate that not everything will work perfectly on the first attempt. However, this is an excellent starting point, and we can make adjustments as needed in the future.
|
Please @okdas and @bryanchriswhite take a look at it again because following most of the conversations with @bryanchriswhite I fully reworked all the devex. Also as @okdas mentioned in a comment, we should take a single path for the CI instead of both (host & docker). Right now, they are both here to demonstrate that we can test in any way with the CI. |
|
|
package.json
Outdated
| "docker:ps:production": "yarn run docker:compose production ps", | ||
| "docker:stop:production": "yarn run docker:compose production stop", | ||
| "docker:clean:production": "yarn run docker:compose production down -v", | ||
| "docker:tunnel:production": "yarn run docker:check-env:production && ./scripts/proxy-tunnel.sh production", |
There was a problem hiding this comment.
Can we reduce docker:tunnel to a single yarn script?
There was a problem hiding this comment.
thing is how it will do the proper checks using the right docker-compose file and dotenv without noticing the environment he is trying to reach.
There was a problem hiding this comment.
@bryanchriswhite I get it done on the latest commit, please review it again and let me know.
|
Is there a reason we can't use a single docker-compose.yml? |
every environment has significant differences:
So to avoid commit .env. files which is an ugly practice, exists just a |
|
|
- Add Prettier - Add Eslint - Add CI GitHub workflows: - Add On Host CI (run things locally) - Add On Docker CI (run things with docker) - Add Cache Cleanup after PR merge - Add baseline for Test (but are not working) - Remove env variable `WATCH` in favor of using `NODE_ENV` as the driver for dependencies and execution simplifying DevEx - Remove old GitHub Workflows
Added separate dotenv files (.env.development, .env.test, .env.production) for different environments. Docker commands run in the environment specified by these dotenv files. Also, updated Docker-compose, Dockerfiles, and script files to accommodate these changes. Improved codegen scripts for ESLint and Prettier.
This commit enhances various code comments for improved understanding and clarity. Also, configurations have been updated in ".prettierrc" and ".eslintrc.js" to better align with coding standards. Furthermore, a minor modification to "scripts/build.sh" improves the clarity of a logging message.
…ration Streamlined environment configuration for better management and readability. Refactored package.json scripts to use new script files and clearly define environment related tasks. Additionally, updated Docker setup and distribute new configuration across different compose and Dockerfile files for more explicit handling of development, test, and production environments.
This commit includes several changes, primarily focusing on updating CI workflows and improving Docker setup. CI workflows were updated to optimize the docker building process by using matrix strategies and updating dependencies. Moreover, changes are made to package.json and docker-compose scripts to ensure smooth interaction with Docker and to introduce new environment variables for better control. Finally, the tunnel setup and cleanup for the proxy between the localnet and Docker have been improved for better development experience.
The commit removes specific environment (env) details from the Continuous Integration (CI) job's name in the Docker workflow file. This simplifies the job name, providing a more general and cleaner view in the workflow jobs dashboard.
Updated Dockerfiles to use Node.js 22.5, removing outdated comments from several scripts. Enhanced the README with details on available scripts and improved clarity of instructions.
|
Going to merge this in and we'll fix things along the way as they come up. @jorgecuesta Appreciate your quick turnarounds and responsiveness. |
Refactor Code Comments and Update Configurations
To ensure readability and maintainability, various code comments have been redefined for improved understanding and clarity. Configurations in ".prettierrc" and ".eslintrc.js" have been updated to better align with coding standards. A minor modification has been made to "scripts/build.sh" to enhance the clarity of a logging message.
Update .env File Handling and Introduce Docker Environment Settings
To handle different development environments, separate .env files (.env.development, .env.test, .env.production) have been introduced. Docker commands are now set to run in the environment specified by these .env files. Docker-compose and Dockerfiles, along with script files, have been updated accordingly. Also, codegen scripts for ESLint and Prettier have been improved.
Revamp CI Tooling and Workflows
In this updated version, Prettier and ESLint have been introduced for an enhanced development workflow. New GitHub workflows that enable running processes locally as well as with Docker, and cleaning up the cache after a PR merge, have been incorporated. The test baseline has been initialized for future test implementations. Outdated GitHub workflows have been removed.
With these updates, significant improvements are expected in various aspects of the development process, ranging from CI/CD workflows and environment configuration, to comment clarity and coding configuration.
Check the GitHub Actions on a PR that I open as disposable on my repository to just be sure the CI is working as expected.
Type of change
Select one or more:
Sanity Checklist