Repository navigation
docs: fix broken CloudEvents spec link in source comment - #668
Merged
Merged
Conversation
The cloudevents/spec repository renamed its default branch from master to main and moved spec.md under cloudevents/. Update the code comment in CloudEvent validation that still pointed at the old, now 404, location. Signed-off-by: Adam Boulware <adam@adamboulware.com>
Contributor
|
LGTM |
This file contains hidden or 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
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.
Proposed Changes
cloudevents/speclink in source code:src/event/cloudevent.ts(a//code comment above the extension valuetype check) pointed at
blob/master/spec.md#type-system, which now 404s.It now points at
blob/main/cloudevents/spec.md#type-system.Related to #667. Same root cause:
cloudevents/specrenamed its default branchfrom
mastertomainand movedspec.mdintocloudevents/. #667 fixes theREADME community links; this PR does not touch the README.
Description
Only the URL text changed (one line, no reflow). The link is in a plain code
comment, so it is not shown in generated docs or to library users.
Verification:
github.com/cloudevents/specURL insrc/andtest/withcurl. The only one returning 404 was themaster/spec.mdlink above. Therest are pinned to tags (
v1.0,v1.0.1) and still return 200, so they areleft alone.
#type-systemanchor was checked against the raw markdown:main'scloudevents/spec.mdhas a### Type Systemheading, which produces that slug.CHANGELOG.mdentry that links to the oldmaster/spec.md(historical record) and the README links (handled in docs: fix broken CloudEvents community links in README #667).npx eslint src/event/cloudevent.tspasses;git diff --checkis clean.