-
-
Notifications
You must be signed in to change notification settings - Fork 264
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
docs: fix links in Markdown files #769
Merged
Merged
Changes from all commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
a866738
fix link
KhudaDad414 6f88534
add paterns
KhudaDad414 533b2d4
Merge pull request #1 from KhudaDad414/patch-1
KhudaDad414 6a355c0
Update mlc_config.json
KhudaDad414 0621892
Update mlc_config.json
KhudaDad414 6d0f1ee
Update mlc_config.json
KhudaDad414 f47850e
ignore another pattern
KhudaDad414 91d1673
Merge branch 'master' into master
derberg 07b088d
Merge branch 'master' into master
derberg 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 |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| { | ||
| "ignorePatterns": [ | ||
| { | ||
| "pattern": "^https://github.com/asyncapi/spec/tree/BRANCH_NAME" | ||
| }, | ||
| { | ||
| "pattern": "^https://github.com/asyncapi/spec-json-schemas/tree/BRANCH_NAME" | ||
| }, | ||
| { | ||
| "pattern": "^https://github.com/asyncapi/parser-js/tree/BRANCH_NAME" | ||
| }, | ||
| { | ||
| "pattern": "^https://github.com/asyncapi/website/pull/PULLREQUEST" | ||
| }, | ||
| { | ||
| "pattern": "^https://github.com/asyncapi/spec/blob/.*.md$" | ||
| } | ||
| ] | ||
| } | ||
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.
Would you mind adding
^https://github.com/asyncapi/spec/blob/.*.md$(or similar)?Just to avoid errors on links that are going to exist only once the particular PR is merged, like during releases of the spec. I.e. https://github.com/asyncapi/spec/runs/6190017382?check_suite_focus=true
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.
MM I think its better to don't add it. As the action is not mandatory for merging prs, and considering this is just an exception, I would just not add this into the ignorePatterns.
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.
yeah, it makes more sense.
@derberg I guess because of cases like this, the decision of making the "link checking workflow"
requiredshould be taken per repo basis or we should not make itrequiredat all?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.
to have it useful it should be required everywhere, we just did not make it required as we know there is a bazillion of links broken and we need few weeks until we get into the stage that "we know we will not cause unexpected CI fails on PR, so we won't annoy contributors" - like we will not cause the problem that developers do not like, like fix thinks not related to PR, not caused by them
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.
@smoya Then, I guess adding it to the ignorePatterns is the only way forward since this link will cause the weekly check and maybe the other PRs to fail after we make it mandatory.
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.
I'm happy to make it required, but then yes, this should be added into the ignorePatterns, otherwise PR's for new releases might fail as links could not exist yet.