rohd-hcl icon indicating copy to clipboard operation
rohd-hcl copied to clipboard

Build system is too strict on checking for document links

Open desmonddak opened this issue 2 years ago • 2 comments

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 avatar Oct 03 '23 05:10 desmonddak

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

mkorbel1 avatar Oct 04 '23 19:10 mkorbel1

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

quekyj avatar Nov 06 '23 09:11 quekyj