feat(docs-linter): add lint for local links #2416
Merged
Conversation
This file contains 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
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #2416 +/- ##
=======================================
Coverage 54.70% 54.71%
=======================================
Files 583 583
Lines 78499 78499
=======================================
+ Hits 42944 42947 +3
+ Misses 32347 32344 -3
Partials 3208 3208
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
leohhhn
changed the title
leohhhn
changed the title
deelawn
approved these changes
Jun 24, 2024
Co-authored-by: deelawn <dboltz03@gmail.com>
deelawn
reviewed
Jun 24, 2024
deelawn
reviewed
Jun 24, 2024
leohhhn
added a commit
that referenced
this pull request
Jun 25, 2024
<!-- please provide a detailed description of the changes made in this pull request. --> ## Description This PR fixes a few broken links in the docs, cherry-picked from #2416. <details><summary>Contributors' checklist...</summary> - [x] Added new tests, or not needed, or not feasible - [x] Provided an example (e.g. screenshot) to aid review or the PR is self-explanatory - [x] Updated the official documentation or not needed - [x] No breaking changes were made, or a `BREAKING CHANGE: xxx` message was included in the description - [x] Added references to related issues and PRs - [x] Provided any useful hints for running manual tests - [x] Added new benchmarks to [generated graphs](https://gnoland.github.io/benchmarks), if any. More info [here](https://github.com/gnolang/gno/blob/master/.benchmarks/README.md). </details>
leohhhn
removed
the
don't merge
gfanton
pushed a commit
to gfanton/gno
that referenced
this pull request
Jul 23, 2024
<!-- please provide a detailed description of the changes made in this pull request. --> ## Description This PR fixes a few broken links in the docs, cherry-picked from gnolang#2416. <details><summary>Contributors' checklist...</summary> - [x] Added new tests, or not needed, or not feasible - [x] Provided an example (e.g. screenshot) to aid review or the PR is self-explanatory - [x] Updated the official documentation or not needed - [x] No breaking changes were made, or a `BREAKING CHANGE: xxx` message was included in the description - [x] Added references to related issues and PRs - [x] Provided any useful hints for running manual tests - [x] Added new benchmarks to [generated graphs](https://gnoland.github.io/benchmarks), if any. More info [here](https://github.com/gnolang/gno/blob/master/.benchmarks/README.md). </details>
gfanton
pushed a commit
to gfanton/gno
that referenced
this pull request
Jul 23, 2024
<!-- please provide a detailed description of the changes made in this pull request. --> ## Description This PR improves the docs linter by adding a `os.Stat` check for local files. It will notify the user if a link to a local file is broken by trying to find the file in question on the filesystem. <details><summary>Contributors' checklist...</summary> - [x] Added new tests, or not needed, or not feasible - [x] Provided an example (e.g. screenshot) to aid review or the PR is self-explanatory - [x] Updated the official documentation or not needed - [x] No breaking changes were made, or a `BREAKING CHANGE: xxx` message was included in the description - [x] Added references to related issues and PRs - [x] Provided any useful hints for running manual tests - [x] Added new benchmarks to [generated graphs](https://gnoland.github.io/benchmarks), if any. More info [here](https://github.com/gnolang/gno/blob/master/.benchmarks/README.md). </details> --------- Co-authored-by: deelawn <dboltz03@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
This PR improves the docs linter by adding a
os.Statcheck for local files. It will notify the user if a link to a local file is broken by trying to find the file in question on the filesystem.Contributors' checklist...
BREAKING CHANGE: xxxmessage was included in the description