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

Build system is too strict on checking for document links #52

Open
desmonddak opened this issue Oct 3, 2023 · 2 comments
Open

Build system is too strict on checking for document links #52

desmonddak opened this issue Oct 3, 2023 · 2 comments
Labels
bug Something isn't working

Comments

@desmonddak
Copy link
Contributor

Describe the bug

When we write documentation we need to refer to HTML files that do not yet exist (e.g., generated schematics) on the deploy site. The generated schematics would likely be part of the add of the same pull request as the referring documentation.

To Reproduce

Create a new html link in a document to an as yet generated schematic in the gen/ area. It may be generatable, but not yet deployed on the production site.

Then push this to a fork and do a pull request. The pull request lint checks will fail.

Expected behavior

Warnings on dead links.

Actual behavior

Failure and job stoppage on 'dead' or really 'not yet alive' links.

Additional: Dart SDK info

No response

Additional: pubspec.yaml

No response

Additional: Context

No response

@desmonddak desmonddak added the bug Something isn't working label Oct 3, 2023
@mkorbel1
Copy link
Contributor

mkorbel1 commented Oct 4, 2023

I'm not sure what the right solution for this is. One possibility is to update links in a following PR?

@quekyj
Copy link
Contributor

quekyj commented Nov 6, 2023

Ya, it is failing on pull request that need generation of the doc. Any workaround on this?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

3 participants