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

feat: Add Notice documentation header check. #1422

Merged
merged 3 commits into from
May 1, 2023

Conversation

bdferris-v2
Copy link
Collaborator

As part of automated Notice documentation extraction (#1324), this PR adds a unit-test to enforce that each Notice has a Javadoc documentation header.

  • Run the unit tests with gradle test to make sure you didn't break anything
  • Format the title like "feat: [new feature short description]". Title must follow the Conventional Commit Specification(https://www.conventionalcommits.org/en/v1.0.0/).
  • Linked all relevant issues
  • Include screenshot(s) showing how this pull request works and fixes the issue(s)

@github-actions
Copy link
Contributor

github-actions bot commented May 1, 2023

✅ Rule acceptance tests passed.
New Errors: 0 out of 1426 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
Dropped Errors: 0 out of 1426 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
New Warnings: 0 out of 1426 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
Dropped Warnings: 0 out of 1426 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
0 out of 1426 sources (~0 %) are corrupted.
Commit: 805e74f
Download the full acceptance test report here (report will disappear after 90 days).
✅ Rule acceptance tests passed.

@github-actions
Copy link
Contributor

github-actions bot commented May 1, 2023

✅ Rule acceptance tests passed.
New Errors: 0 out of 1426 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
Dropped Errors: 0 out of 1426 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
New Warnings: 0 out of 1426 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
Dropped Warnings: 0 out of 1426 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
0 out of 1426 sources (~0 %) are corrupted.
Commit: dcc5e2b
Download the full acceptance test report here (report will disappear after 90 days).
✅ Rule acceptance tests passed.

@bdferris-v2 bdferris-v2 merged commit 0073047 into master May 1, 2023
@bdferris-v2 bdferris-v2 deleted the issue/1324/rules_documentation_test branch May 1, 2023 17:27
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