Fix 2638: Use absolute URL for LICENSE/CHANGELOG in README #2682
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.
Fixes #2638
Changes
Use absolute URL (for example,
https://github.com/open-telemetry/opentelemetry-rust/blob/main/opentelemetry-proto/CHANGELOG.md
) instead of a relative URL (./CHANGELOG.md
).I found that cargo.io treats a relative URL like
<repository URL>/<commit and path in .cargo_vcs_info.json>/<the relative path>
. So the relative path is converted likehttps://github.com/open-telemetry/opentelemetry-rust/tree/main/opentelemetry-otlp/blob/HEAD/opentelemetry-otlp/CHANGELOG.md
. This causes 404 errors.To solve this, we have two options:
https://github.com/open-telemetry/opentelemetry-rust
)https://github.com/open-telemetry/opentelemetry-rust/blob/HEAD/opentelemetry-otlp/CHANGELOG.md
, it is a valid URLAt first I thought to take the option 2, but I found this issue: rust-lang/crates.io#9939.
The issue is not the exact same as our pattern, but they also suffer that cargo.io doesn't treat a relative path as they expected. And the cargo.io maintainer says that developer should use an absolute URL. If we take the option 2, for now it fixes the problem but in the future if cargo.io team does some breaking changes, our URL may be broken again. So I took the first option.
NOTE: In my second commit, I changed homepage/repository URL on opentelemetry/opentelemetry-http/opentelemetry-sdk's Cargo.toml since they are inconsistent against other sub-dir. But technically this change is not related to #2638 .
Merge requirement checklist
CHANGELOG.md
files updated for non-trivial, user-facing changes