ory / ory/closed-reference-notifier
Move ignore marker at the beginning of the url
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 23
- Forks
- 1
- PR merge metrics
- No merged PRs in 30d
Description
Preflight checklist
- I could not find a solution in the existing issues, docs, nor discussions.
- I agree to follow this project's Code of Conduct.
- I have read and am following this repository's Contribution Guidelines.
- This issue affects my Ory Cloud project.
- I have joined the Ory Community Slack.
- I am signed up to the Ory Security Patch Newsletter.
Describe the bug
Related to 5d419e0124280696469e6e862a4ab1cfb39f9d84
[Code] editors usually make link clickable for developers convenience. The ignore marker at the end of the URL might get consider as part of the URL and clicking on them will open a HTTP 404 in our browsers.
Some link checkers might also get confused by this, and report false positives.
Moving the ignore marker a the beginning of the URL should prevent mixing them together as we often have the scheme that delimits the beginning of the URL.
I see that the regex rule to extract the links does not contain any scheme, but maybe we could use https://regex101.com/r/K8XC3H/1 ?
(!!)?((https?:)?\/\/)?github\.com\/([a-zA-Z\d-]+)\/([a-zA-Z\d._-]+)\/(pull|issues)\/(\d+)(!!)?
Reproducing the bug
- Open your IDE and click on a link with the ignore markers.
- Should open a 404 in your browser
Relevant log output
No response
Relevant configuration
No response
Version
v1
On which operating system are you observing this issue?
No response
In which environment are you deploying?
No response
Additional Context
No response
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the link-extraction implementation and any tests for ignored GitHub references; the issue provides the proposed regex and reproduction steps. Verify that the ignore marker is accepted at the URL beginning rather than treated as a URL suffix, and add or update coverage for the described IDE/link-checker case.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- tooling
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100