Testing: add GitHub action to enforce multi-line style comments#127
Merged
rlm2002 merged 1 commit intowolfSSL:masterfrom Jul 16, 2025
Merged
Testing: add GitHub action to enforce multi-line style comments#127rlm2002 merged 1 commit intowolfSSL:masterfrom
rlm2002 merged 1 commit intowolfSSL:masterfrom
Conversation
cconlon
changed the title
cconlon
force-pushed
the
ghActionCommentStyle
branch
2 times, most recently
from
7ecd073 to
687d176
Compare
There was a problem hiding this comment.
Pull Request Overview
Adds a GitHub Action that enforces using multi-line (/* */) comments instead of single-line (//) in .java, .c, and .h files.
- Introduces a CI workflow that lists changed files, filters by extension, and greps for
//-style comments. - Fails the check with an error message if any single-line comments are detected.
- Skips the check if no relevant source files were modified.
Comments suppressed due to low confidence (1)
.github/workflows/comment-style-check.yml:21
- [nitpick] The comment refers to '.c/.h' using a slash; consider rephrasing to list extensions explicitly (e.g., '.java, .c, and .h') to improve readability.
# Get list of changed .java and .c/.h files in this PR
687d176 to
3397110
Compare
…nts, not single line style. Helps us meet coding standards.
cconlon
force-pushed
the
ghActionCommentStyle
branch
from
3397110 to
7ece6ed
Compare
cconlon
assigned
wolfSSL-Bot,
JacobBarthelmeh and
rlm2002 and unassigned
cconlon and
JacobBarthelmeh
rlm2002
approved these changes
Jul 16, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR adds a GitHub action that checks to make sure new code uses multi-line comment style (ie:
/* */) not single line style (ie://), to match internal coding standards.Only checks
.java,.c, and.hsource files changed in a PR.Example of a failure run: https://github.com/wolfSSL/wolfcrypt-jni/actions/runs/16276508001/job/45956586842?pr=127