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

[bug] build script does not check for invalid or duplicate IDs #88

Closed
funnelfiasco opened this issue Nov 27, 2024 · 2 comments · Fixed by #92
Closed

[bug] build script does not check for invalid or duplicate IDs #88

funnelfiasco opened this issue Nov 27, 2024 · 2 comments · Fixed by #92

Comments

@funnelfiasco
Copy link
Contributor

The build script does not currently check to see if an ID appears twice or if an ID does not follow our defined format, which means we could end up re-using an ID by accident or adding an invalid ID.

I think the best way would be to add a check command that validates IDs (and possibly other fields), so that we can run just the check as a CI workflow on pull requests. The compile command, which produces actual output, could either call the check first, or we can adjust the pages workflow to include a validate step before the compile step as a backstop against something sneaking in accidentally.

@eddie-knight
Copy link
Contributor

eddie-knight commented Nov 29, 2024

Related, possibly separate... we need to sort the entries according to category now that #87 is merged! Puerco and I noticed that it takes a bit of searching to make sure you're using the right ID when making a new entry.

Also related, possibly separate... we should talk about (and document) what the project will do with an ID in the event that an entry is deprecated or removed after an official release. It will be cumbersome to users if an ID is reused for a different entry.

@funnelfiasco
Copy link
Contributor Author

Opened #94 and #96 for the points Eddie raised above.

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

Successfully merging a pull request may close this issue.

2 participants