Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Set up a minimal CI #10

Merged
merged 5 commits into from
Mar 12, 2024
Merged

Set up a minimal CI #10

merged 5 commits into from
Mar 12, 2024

Conversation

lebaudantoine
Copy link
Contributor

@lebaudantoine lebaudantoine commented Mar 5, 2024

Purpose

Maintain high quality code standards + Improve DX while reviewing code

Proposal

Set up a minimal CI configuration which will lint git commits, code sources, and build static sources.
Also, we will maintain dependencies up-to-date using renovate bot.

As soon as the PR is merged, I will set up these two jobs as required to merge any PR.

@lebaudantoine lebaudantoine force-pushed the init-ci branch 17 times, most recently from 05866e2 to 59f7670 Compare March 5, 2024 17:37
@lebaudantoine lebaudantoine marked this pull request as ready for review March 5, 2024 17:39
@lebaudantoine lebaudantoine self-assigned this Mar 5, 2024
@lebaudantoine lebaudantoine changed the title WIP add a ci Set up a minimal CI Mar 5, 2024
@lebaudantoine lebaudantoine marked this pull request as draft March 5, 2024 17:51
@lebaudantoine lebaudantoine requested review from manuhabitela and removed request for manuhabitela March 5, 2024 17:51
@lebaudantoine lebaudantoine marked this pull request as ready for review March 5, 2024 22:36
Copy link
Collaborator

@manuhabitela manuhabitela left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Didn't really test it as it's kinda annoying to do for those CI things.

But seems great to me looking at it, great job :)

.github/ISSUE_TEMPLATE/Bug_report.md Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/Feature_request.md Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/Support_question.md Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/Support_question.md Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/Support_question.md Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/Support_question.md Outdated Show resolved Hide resolved
.github/workflows/lasuite.yaml Show resolved Hide resolved
It's a general good practice to pin dependencies,
to make Developer setup reproducible, and on
pair with CI tools.

Additionaly, to avoid updating manually every
dependencies, set-up renovate bot, that will open
a PR every week to automatically update deps.
Enhance Prettier configs. It now runs only on all ts,
tsx, md, json, cjs, js sources.

Its configs are declared under prettierrc.json file.
Some sources are ignored, please take a look at
.prettierignore

Follow Next.js documentation to configure Prettier along
with the default ESLint linter.
Add default template files.

The pull request template contains two sections:
- Purpose
- Proposal

The issues templates are for:
- Bug report
- Feature request
- Support questions
Add first Github workflow, which lints git commits.
Make sure the title and body respect team's rule, using
a Python package, GitLint, which was extended with a
custom rule.

This workaround is copy/paste from people repo.
It might be refactored in a near futur in a clean Github
action, instead of duplicating the logic.

A step has been added to look for fixup commits in
git log's output. It's not handled natively by the
GitLint Python package.
Add a new job that ensure that all code sources
pass ESLint lint rules, Prettier lint rules, and we
can build the static output from code sources.

It makes sure we maintain a high code quality,
and that merging code into the main branch
won't result in error in Scalingo deployment.
@lebaudantoine lebaudantoine merged commit 8747748 into main Mar 12, 2024
2 of 3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants