8000 Pre-commit.ci test by lucasssvaz · Pull Request #2 · lucasssvaz/arduino-esp32 · GitHub
[go: up one dir, main page]
Skip to content

Pre-commit.ci test #2

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.

Sign up for GitHub

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

Jump to bottom
Closed
wants to merge 4 commits into from
Closed

Pre-commit.ci test #2

wants to merge 4 commits into from

Conversation

lucasssvaz
Copy link
Owner
@lucasssvaz lucasssvaz commented Jan 22, 2024 •
edited
Loading

Testing of pre-commit.ci lite. Configured to run only in modified files.

@github-actions GitHub Actions
Copy link
github-actions bot commented Jan 22, 2024 •
edited
Loading
Warnings
⚠️

Some issues found for the commit messages in this PR:

  • the commit message "Config files only":
    • summary looks empty
    • type/action looks empty
  • the commit message "Fix codespell config":
    • summary looks empty
    • type/action looks empty
  • the commit message "Make codespell manual":
    • summary looks empty
    • type/action looks empty
  • the commit message "[pre-commit.ci lite] apply automatic fixes":
    • summary looks empty
    • type/action looks empty

Please fix these commit messages - here are some basic tips:

  • follow Conventional Commits style
  • correct format of commit message should be: <type/action>(<scope/component>): <summary>, for example fix(esp32): Fixed startup timeout issue
  • allowed types are: change,ci,docs,feat,fix,refactor,remove,revert,test
  • sufficiently descriptive message summary should be between 20 to 72 characters and start with upper case letter
  • avoid Jira references in commit messages (unavailable/irrelevant for our customers)

TIP: Install pre-commit hooks and run this check when committing (uses the Conventional Precommit Linter).
Messages
📖 You might consider squashing your 4 commits (simplifying branch history).

👋 Hello lucasssvaz, we appreciate your contribution to this project!

Click to see more instructions ...


This automated output is generated by the PR linter DangerJS, which checks if your Pull Request meets the project's requirements and helps you fix potential issues.

DangerJS is triggered with each push event to a Pull Request and modify the contents of this comment.

Please consider the following:
- Danger mainly focuses on the PR structure and formatting and can't understand the meaning behind your code or changes.
- Danger is not a substitute for human code reviews; it's still important to request a code review from your colleagues.
- Resolve all warnings (⚠️ ) before requesting a review from human reviewers - they will appreciate it.
- Addressing info messages (📖) is strongly recommended; they're less critical but valuable.
- To manually retry these Danger checks, please navigate to the Actions tab and re-run last Danger workflow.

Review and merge process you can expect ...


We do welcome contributions in the form of bug reports, feature requests and pull requests.

1. An internal issue has been created for the PR, we assign it to the relevant engineer.
2. They review the PR and either approve it or ask you for changes or clarifications.
3. Once the GitHub PR is approved we do the final review, collect approvals from core owners and make sure all the automated tests are passing.
- At this point we may do some adjustments to the proposed change, or extend it by adding tests or documentation.
4. If the change is approved and passes the tests it is merged into the default branch.

Generated by 🚫 dangerJS against 30f0e98

@lucasssvaz lucasssvaz force-pushed the ci/pre-commit-ci_test branch 3 times, most recently from 4515d1d to 8bdc3d0 Compare January 22, 2024 18:20
@lucasssvaz
Copy link
Owner Author

Adding dummy non-formatted file to test.

@lucasssvaz
Copy link
Owner Author

Looks ok. Adding another dummy file.

@lucasssvaz
Copy link
Owner Author
lucasssvaz commented Jan 22, 2024 •
edited
Loading

Looks OK. Changing the style updates old files as well. Testing adding mixed file types and changing already existing files.

@lucasssvaz
Copy link
Owner Author
lucasssvaz commented Jan 23, 2024 •
edited
Loading

C/C++ files looks ok. Black cannot always fix everything by itself (for example in dummy.py). When adding the python linter we will need to adjust some files manually. For files it can't fix, the CI will fail and show in the log where formatting errors were detected. Testing codespell.

@lucasssvaz lucasssvaz force-pushed the ci/pre-commit-ci_test branch from c2eb6fd to a1628df Compare January 23, 2024 02:08
@lucasssvaz
Copy link
Owner Author

Codespell works fine. Just need to be careful with false positives when updating the codebase by locally disabling the write flag and adding the false positives to the config file.

@lucasssvaz lucasssvaz force-pushed the ci/pre-commit-ci_test branch from 1451bf0 to 5e32c38 Compare January 23, 2024 02:33
@lucasssvaz
Copy link
Owner Author

Separated codespell config into a new file to make it more intuitive. Also delete pyproject and move black config as hook argument (as it was just one option). Need to investigate prettier and yamllint.

@lucasssvaz lucasssvaz force-pushed the ci/pre-commit-ci_test branch 7 times, most recently from d81b7c9 to 240ac9a Compare January 24, 2024 11:11
@lucasssvaz
Copy link
Owner Author

Prettier and yamllint looks properly configured. Testing in the entire codebase to check for any potential issues.

@lucasssvaz lucasssvaz force-pushed the ci/pre-commit-ci_test branch from 807aad0 to 6a4d292 Compare January 24, 2024 11:37
@lucasssvaz lucasssvaz force-pushed the ci/pre-commit-ci_test branch from 5f3384a to 69f551e Compare January 24, 2024 12:57
@lucasssvaz lucasssvaz force-pushed the ci/pre-commit-ci_test branch from 69f551e to 30f0e98 Compare January 24, 2024 17:46
@lucasssvaz lucasssvaz mentioned this pull request Jan 24, 2024
Merged
@lucasssvaz lucasssvaz closed this Jan 26, 2024
@lucasssvaz lucasssvaz deleted the ci/pre-commit-ci_test branch February 7, 2024 13:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@lucasssvaz
0