-
Notifications
You must be signed in to change notification settings - Fork 10
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
3782 - Add doc lint github action #136
Open
diana-borbe-consensys
wants to merge
7
commits into
main
Choose a base branch
from
3782
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
06de576
3782 - Add doc lint github action
diana-borbe-consensys 0038d52
Update
diana-borbe-consensys 0b7e737
Update
diana-borbe-consensys 200f416
Update .github/pull_request_template.md
diana-borbe-consensys 0b96f1f
Merge branch 'main' into 3782
diana-borbe-consensys f314961
Merge branch 'main' into 3782
diana-borbe-consensys dd62af3
Merge branch 'main' into 3782
diana-borbe-consensys File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,35 @@ | ||
This PR implements issue(s) # | ||
## Description | ||
<!-- Provide a brief description of the changes in this PR --> | ||
|
||
### Checklist | ||
## Related Issue | ||
|
||
* [ ] I wrote new tests for my new core changes. | ||
* [ ] I have successfully ran tests, style checker and build against my new changes locally. | ||
* [ ] I have informed the team of any breaking changes if there are any. | ||
This PR addresses/relates to issue(s) # | ||
<!-- If this PR addresses an existing issue, please link to it here --> | ||
<!-- e.g., Fixes #123 --> | ||
|
||
## Type of Change | ||
<!-- Mark the appropriate option with an "x" --> | ||
- [ ] Bug fix (non-breaking change which fixes an issue) | ||
- [ ] New feature (non-breaking change which adds functionality) | ||
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) | ||
- [ ] This change requires a documentation update | ||
|
||
## How Has This Been Tested? | ||
<!-- Describe the tests you ran to verify your changes --> | ||
<!-- Include details of your testing environment, and the tests you ran --> | ||
|
||
## Checklist: | ||
<!-- Mark completed items with an "x" --> | ||
|
||
- [ ] My code follows the style guidelines of this project | ||
- [ ] I have performed a self-review of my own code | ||
- [ ] I have commented my code, particularly in hard-to-understand areas | ||
- [ ] I have made corresponding changes to the documentation | ||
- [ ] I have informed the team of any breaking changes if there are any | ||
- [ ] My changes generate no new warnings | ||
- [ ] I wrote new tests for my new core changes | ||
- [ ] I have successfully ran tests, style checker and build against my new changes locally | ||
- [ ] Any dependent changes have been merged and published in downstream modules | ||
|
||
## Additional Notes | ||
<!-- Add any other information about the PR here --> |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
|
||
name: Documentation - Check for lint/build errors | ||
|
||
on: | ||
pull_request: | ||
paths: | ||
- "**/*.md" | ||
branches: | ||
- main | ||
|
||
jobs: | ||
# This job is commented out because of the missing package-lock.json file | ||
# lint: | ||
# name: Lint Code Base, Spelling | ||
# runs-on: [self-hosted, ubuntu-22.04, X64, small] | ||
# timeout-minutes: 10 | ||
# permissions: | ||
# contents: read | ||
# env: | ||
# NODE_VERSION: v20.9.0 | ||
# steps: | ||
# - uses: actions/checkout@v4 | ||
# - name: Create .nvmrc file | ||
# run: | | ||
# echo "${{ env.NODE_VERSION }}" > .nvmrc | ||
# - name: Lint | ||
# uses: Consensys/docs-gha/lint@main | ||
# with: | ||
# GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
|
||
linkCheck: | ||
name: Link Checking | ||
runs-on: [self-hosted, ubuntu-22.04, X64, small] | ||
diana-borbe-consensys marked this conversation as resolved.
Show resolved
Hide resolved
|
||
timeout-minutes: 10 | ||
permissions: | ||
contents: read | ||
strategy: | ||
matrix: | ||
file-extensions: [".md"] | ||
steps: | ||
- uses: actions/checkout@v4 | ||
- name: LinkCheck | ||
uses: Consensys/docs-gha/linkcheck@main | ||
with: | ||
FILE_EXTENSION: '${{ matrix.file-extensions }}' | ||
CONFIG_FILE: 'doc_config.json' |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
{ | ||
"ignorePatterns": [ | ||
{ | ||
"pattern": "https://github.com/" | ||
}, | ||
{ | ||
"pattern": "https://twitter.com/" | ||
}, | ||
{ | ||
"pattern": "https://support.metamask.io/" | ||
}, | ||
{ | ||
"pattern": "https://infura.io/faucet/linea" | ||
}, | ||
{ | ||
"pattern": "https://www.infura.io/faucet/linea" | ||
}, | ||
{ | ||
"pattern": "https://infura.io" | ||
}, | ||
{ | ||
"pattern": "https://rpc.sepolia.linea.build" | ||
} | ||
] | ||
} |
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do we need an additional section for
hotfix
or do you thinkBug fix
already covers it?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can include both in same category. Do you prefer to keep them separate ?