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

CI - Enhancing Quality Checks with Biome, Reviewdog & Workflow Updates #2

Merged
merged 6 commits into from
Apr 4, 2024

Conversation

suddenlyGiovanni
Copy link
Owner

This pull request introduces a series of enhancements aimed at improving the quality of code and workflow efficiency.

Specifically, the changes include:

  • The addition of a GitHub Actions workflow that performs code quality checks on pull requests targeting the main branch. This workflow sets up a pnpm environment, installs dependencies, and runs validation checks using Biome.
  • The introduction of @biomejs/biome as a development dependency, and the addition of related development scripts in package.json.
  • A new biome.json file to outline configurations for file formatting.
    The inclusion of a pnpm-lock.yaml containing package-lock information.
  • The creation of biome.xml and jsLibraryMappings.xml files in the .idea directory, set to provide settings for code formatting and linking to the Node.js library in the project respectively.
  • An update to package.json to declare pnpm as the designated package manager for the project.
  • A new workflow that checks code in pushed updates, which includes formatting code with Biome and auto-committing lint fixes with Git.
  • The integration of Reviewdog checks in the main GitHub Actions workflow. This includes checks for LINThub actions (action lint, shell check, markdown lint, Biome, misspell actions) to ensure the code adheres to various language rules and best practices.

These changes collectively contribute to improved code quality and workflow reliability.

This commit introduces reviewdog checks to Github actions workflow. The new checks include actionlint, shellcheck, markdownlint, Biome, and misspell actions, set to be run on pull requests. The workflow leverages several reviewdog actions ensuring code adherence to various language rules and best practices, thus improving code quality and reliability.
A new workflow for push checks has been added, which includes several steps such as code checkout, pnpm installation, dependencies installation, and code formatting with Biome. Git auto commit function for lint fixes is also incorporated in the new workflow.
A `packageManager` field was added to the `package.json` file. This was done to specify `[email protected]` as the designated package manager for the project.
The commit introduces new 'biome.xml' and 'jsLibraryMappings.xml' files in the '.idea' directory. The 'biome.xml' file is set to format on save, while 'jsLibraryMappings.xml' links to Node.js library in the project directory.
This commit adds the @biomejs/biome as a devDependency and updates the package.json to include format scripts. A new biome.json file is introduced, providing configurations for file formatting. Lastly, the pnpm-lock.yaml file is generated with relevant package-lock information.
This commit introduces a new GitHub Actions workflow for pull request checks. The workflow performs various actions such as code checkout, node.js setup, dependencies installation, and code error checking using Biome. It is designed to run on pull request events targeting the main branch.
Copy link

changeset-bot bot commented Apr 4, 2024

⚠️ No Changeset found

Latest commit: 5098b98

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@suddenlyGiovanni suddenlyGiovanni merged commit fa65c57 into main Apr 4, 2024
6 of 7 checks passed
@suddenlyGiovanni suddenlyGiovanni deleted the ci/pr-checks branch April 4, 2024 18:04
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.

1 participant