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

Improve documentation detection #186

Merged
merged 3 commits into from
Sep 21, 2023
Merged

Improve documentation detection #186

merged 3 commits into from
Sep 21, 2023

Conversation

spenserblack
Copy link
Owner

  • Mark files in any docs directory as vendored
  • Mar CHANGELOGs and READMEs as documentation
  • Detect HACKING.* as documentation

This was previously only checking the top-level directory, so
subdirectories would not get marked as documentation.

Also, this check was for files in *directories called `docs`*, so it's a
bit invalid to check on the directory/file itself.
@spenserblack spenserblack added the semver-patch This pull request bumps the patch version label Sep 21, 2023
@codecov
Copy link

codecov bot commented Sep 21, 2023

Codecov Report

Merging #186 (232569f) into main (a170dab) will increase coverage by 0.23%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##             main     #186      +/-   ##
==========================================
+ Coverage   85.45%   85.68%   +0.23%     
==========================================
  Files          14       14              
  Lines         543      552       +9     
==========================================
+ Hits          464      473       +9     
  Misses         79       79              
Flag Coverage Δ
85.68% <100.00%> (+0.23%) ⬆️
macOS-latest 85.63% <100.00%> (+0.23%) ⬆️
ubuntu-latest 82.27% <100.00%> (+0.29%) ⬆️
windows-latest ?

Flags with carried forward coverage won't be shown. Click here to find out more.

Files Changed Coverage Δ
gengo/src/documentation.rs 100.00% <100.00%> (ø)

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@spenserblack spenserblack merged commit f70c252 into main Sep 21, 2023
11 checks passed
@spenserblack spenserblack deleted the documentation-files branch September 21, 2023 14:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
semver-patch This pull request bumps the patch version
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant