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

Validator: make github field required for block_content examples #63

Open
Laren-AWS opened this issue Aug 6, 2024 · 3 comments
Open
Assignees

Comments

@Laren-AWS
Copy link
Contributor

Currently, the github field is optional for examples, but the downstream effect of this is that WRITEME omits the example from the README, which is not intentional.

For the root repo (possibly under strict mode?), we should require this field at least for block_content examples, and possibly for all examples so that they are correctly included in the READMEs.

It is a valid case to omit this field when the source examples are in a tributary that's stored somewhere inaccessible, so we must allow a switch for this to optional.

@Laren-AWS
Copy link
Contributor Author

There are quite a few of these in cross_metadata.yaml, so this task will require first being implemented as a warning, then cleaning up all the metadata, then making it an actual blocking error.

@Laren-AWS
Copy link
Contributor Author

I have the code for this update to the tool ready in a branch. I'll open an epic to track updating the example metadata.

@Laren-AWS
Copy link
Contributor Author

Blocked until the epic to make the underlying metadata updates is completed: awsdocs/aws-doc-sdk-examples#7012.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant