Skip to content
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

markdown-link-checker on CI fails for docs.rs links of unreleased versions #1168

Closed
Br1ght0ne opened this issue Oct 16, 2023 · 1 comment
Closed
Labels
ci GitHub CI build/pipeline documentation Improvements or additions to documentation

Comments

@Br1ght0ne
Copy link
Contributor

Br1ght0ne commented Oct 16, 2023

Our versioned links (docs.rs/{{versions.package-name}}, implemented in #1098) work great, unless the PR bumps the versions to prepare for a release. In this case, the replaced links in the CI run for this release PR will point to a (yet) unreleased version of a fuels-* package.

The CI check should be made skippable/not required to allow seamless releases and versioned links at the same time.

@Br1ght0ne Br1ght0ne added documentation Improvements or additions to documentation ci GitHub CI build/pipeline labels Oct 16, 2023
@Br1ght0ne Br1ght0ne self-assigned this Mar 20, 2024
Br1ght0ne added a commit that referenced this issue May 21, 2024
While #1168 is unfinished, we
should hardcode the used versions in the documentation URLs.

Please note that this PR:
- does **NOT** address #1168
- requires incorporating the updating of versions in the changed files
on each release. @digorithm

### Checklist
- [x] I have linked to any relevant issues.
- [x] I have updated the documentation.
- [x] I have added tests that prove my fix is effective or that my
feature works.
- [x] I have added necessary labels.
- [x] I have done my best to ensure that my PR adheres to [the Fuel Labs
Code Review
Standards](https://github.com/FuelLabs/rfcs/blob/master/text/code-standards/external-contributors.md).
- [x] I have requested a review from the relevant team or maintainers.
@Br1ght0ne Br1ght0ne removed their assignment May 24, 2024
@An-tol

This comment was marked as off-topic.

ak-tech007 added a commit to ak-tech007/Rust-SDK that referenced this issue Dec 6, 2024
While FuelLabs/fuels-rs#1168 is unfinished, we
should hardcode the used versions in the documentation URLs.

Please note that this PR:
- does **NOT** address #1168
- requires incorporating the updating of versions in the changed files
on each release. @digorithm

### Checklist
- [x] I have linked to any relevant issues.
- [x] I have updated the documentation.
- [x] I have added tests that prove my fix is effective or that my
feature works.
- [x] I have added necessary labels.
- [x] I have done my best to ensure that my PR adheres to [the Fuel Labs
Code Review
Standards](https://github.com/FuelLabs/rfcs/blob/master/text/code-standards/external-contributors.md).
- [x] I have requested a review from the relevant team or maintainers.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci GitHub CI build/pipeline documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants