newrelic / newrelic-quickstarts

New Relic One quickstarts help accelerate your New Relic journey by providing immediate value for your specific use cases.
https://newrelic.com/instant-observability/
Apache License 2.0
109 stars 298 forks source link

feat: NR-305852 Check for missing quickstart IDs #2550

Closed mickeyryan42 closed 4 days ago

mickeyryan42 commented 6 days ago

https://new-relic.atlassian.net/browse/NR-305852

Summary

The job runs conditionally in PRs when the base is main and the head ref is release and validates that all quickstarts have IDs. Also removing the requirement for the id on quickstarts because it isn't required at PR time and they're generated later. We cant remove the id entirely because then when we validate on the main branch it'll fail, so i've just made them optional.

d3caf commented 5 days ago

Question: is this actually redundant, though? The schema validation ensures that quickstarts have IDs already. https://github.com/d3caf/newrelic-quickstarts/actions/runs/10832538755/job/30057139055?pr=9

josephgregoryii commented 5 days ago

Question: is this actually redundant, though? The schema validation ensures that quickstarts have IDs already.

This made me think, what if its a new quickstart being created? We don't have an ID for that quickstart yet

mickeyryan42 commented 5 days ago

Question: is this actually redundant, though? The schema validation ensures that quickstarts have IDs already.

This made me think, what if its a new quickstart being created? We don't have an ID for that quickstart yet

We have a workflow that runs on merge to the release branch, creates IDs and commits them back to the branch. So maybe we need to think about excluding that validation from this branch or something, and only validate on merge to main?

d3caf commented 4 days ago

Update after standup: we're not going to require id on quickstarts since this is auto-generated by another workflow. The job being added in this PR will ensure that all quickstarts have IDs assigned when we merge from release -> main.