Repository navigation
Release/v2.0.20 - #722
Release/v2.0.20#722
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #722 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 15 15
Lines 559 562 +3
Branches 169 171 +2
=========================================
+ Hits 559 562 +3 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Coverage Report for CI Build 26197698220Warning No base build found for commit Coverage: 100.0%Details
Uncovered ChangesNo uncovered changes found. Coverage RegressionsRequires a base build to compare against. How to fix this → Coverage Stats
💛 - Coveralls |
There was a problem hiding this comment.
Pull request overview
Release housekeeping for v2.0.20, updating changelog entries, adjusting auth-sanitizer loading coverage annotations, and regenerating/publishing YARD documentation artifacts.
Changes:
- Add v2.0.20 entry and update compare/tag links in
CHANGELOG.md. - Add
:nocov:markers around hard-to-cover branches inlib/oauth2/auth_sanitizer.rb. - Regenerate docs under
docs/(including link adjustments and newdocs/frames.html), plus a small README badge update.
Reviewed changes
Copilot reviewed 21 out of 21 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| REEK | Updates stored reek output (currently contains an error message). |
| README.md | Updates KLOC badge value. |
| lib/oauth2/auth_sanitizer.rb | Adds :nocov: markers around gem resolution and loader-not-found error paths. |
| docs/OAuth2/Strategy/Implicit.html | Regenerated docs artifact; now empty output. |
| docs/OAuth2/Strategy/Base.html | Regenerated docs artifact; now empty output. |
| docs/OAuth2/Strategy/AuthCode.html | Updates generated footer timestamp. |
| docs/OAuth2/Strategy/Assertion.html | Updates generated footer timestamp. |
| docs/OAuth2/Response.html | Updates generated footer timestamp. |
| docs/OAuth2/Error.html | Updates generated footer timestamp. |
| docs/OAuth2/Client.html | Updates generated content (logger docs) and footer timestamp. |
| docs/OAuth2/Authenticator.html | Regenerated docs artifact; now empty output. |
| docs/OAuth2/AccessToken.html | Updates generated footer timestamp. |
| docs/index.html | Updates several documentation links and footer timestamp. |
| docs/frames.html | Adds a frames/hash redirect helper page for docs. |
| docs/file.REEK.html | Regenerated docs artifact; now empty output. |
| docs/file.README.html | Regenerated docs artifact; now empty output. |
| docs/file.LICENSE.html | Regenerated docs artifact; now empty output. |
| docs/file.FUNDING.html | Regenerated docs artifact; now empty output. |
| docs/file.CODE_OF_CONDUCT.html | Regenerated docs artifact; now empty output. |
| docs/class_list.html | Regenerated docs artifact; now empty output. |
| CHANGELOG.md | Adds v2.0.20 release notes and updates compare/tag references. |
Comments suppressed due to low confidence (7)
docs/index.html:581
- These links were changed to point to
SECURITY.md/IRP.md, but those markdown files are not in thedocs/output. On the rendered YARD site this will likely break navigation; link to the generatedfile.SECURITY.html/file.IRP.htmlpages or an external source that will exist at runtime.
<p>NOTE: The 1.4 series will only receive critical security updates.<br>
See <a href="SECURITY.md">SECURITY.md</a> and <a href="IRP.md">IRP.md</a>.</p>
docs/index.html:1556
- Several references in the Security/Contributing section were switched to relative markdown files (
SECURITY.md,THREAT_MODEL.md,IRP.md,CONTRIBUTING.md) andREEK, but these files are not indocs/. This will make the published docs contain broken links; prefer the generated YARDfile.*.htmlpages or absolute links to the repository files.
<p>For more see <a href="SECURITY.md">SECURITY.md</a>, <a href="THREAT_MODEL.md">THREAT_MODEL.md</a>, and <a href="IRP.md">IRP.md</a>.</p>
<h2 id="-contributing">🤝 Contributing</h2>
<p>If you need some ideas of where to help, you could work on adding more code coverage,<br>
or if it is already 💯 (see <a href="#code-coverage">below</a>) check <a href="REEK">reek</a>, <a href="https://github.com/ruby-oauth/oauth2/issues">issues</a>, or <a href="https://github.com/ruby-oauth/oauth2/pulls">PRs</a>,<br>
or use the gem and think about how it could be better.</p>
<p>We <a href="https://keepachangelog.com/en/1.0.0/"><img src="https://img.shields.io/badge/keep--a--changelog-1.0.0-34495e.svg?style=flat" alt="Keep A Changelog"></a> so if you make changes, remember to update it.</p>
<p>See <a href="CONTRIBUTING.md">CONTRIBUTING.md</a> for more detailed instructions.</p>
docs/index.html:1640
- The Versioning/License section now links to
CHANGELOG.mdandLICENSE.txtas relative paths, but those files are not part of the generateddocs/site output. This will likely 404 on the documentation site; link tofile.CHANGELOG.html/file.LICENSE.html(or another generated doc page) or use absolute repository URLs.
<p>See <a href="CHANGELOG.md">CHANGELOG.md</a> for a list of releases.</p>
<h2 id="-license">📄 License</h2>
<p>The gem is available as open source under the terms of<br>
the <a href="LICENSE.txt">MIT License</a> <a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/License-MIT-259D6C.svg" alt="License: MIT"></a>.<br>
See <a href="LICENSE.txt">LICENSE.txt</a> for the official <a href="https://opensource.stackexchange.com/questions/5778/why-do-licenses-such-as-the-mit-license-specify-a-single-year">Copyright Notice</a>.</p>
docs/class_list.html:1
- This file is now empty in the generated docs output.
docs/index.htmland other pages expectclass_list.htmlto contain the navigation tree, so publishing an empty file will break documentation navigation. Please ensure the YARD generation step outputs the full class list content here.
docs/OAuth2/Authenticator.html:1 - This generated documentation page is now an empty file. Since
OAuth2::Authenticatoris part of the public API, publishing an empty HTML page effectively removes its docs from the site; please fix the YARD generation so the class documentation is emitted here (or adjust the doc publishing step so this file is not blank).
docs/OAuth2/Strategy/Implicit.html:1 - This strategy documentation page is now empty in
docs/. If the class still exists inlib/oauth2/strategy/implicit.rb, shipping blank YARD output will break deep links and navigation; please ensure YARD is generating and publishing theOAuth2::Strategy::Implicitdocs as before (or update internal links/templates accordingly).
docs/OAuth2/Strategy/Base.html:1 docs/OAuth2/Strategy/Base.htmlis now empty. This page is referenced by other strategy docs as the superclass, so an empty file breaks navigation and removes API documentation; please ensure the docs build publishes the full YARD output forOAuth2::Strategy::Base.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
No description provided.