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

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

Merged
merged 5 commits into from
Sep 12, 2024

Conversation

mickeyryan42
Copy link
Contributor

@mickeyryan42 mickeyryan42 commented Sep 11, 2024

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.

@mickeyryan42 mickeyryan42 requested review from a team, d3caf and aswanson-nr and removed request for a team September 11, 2024 14:57
.github/workflows/pr-checks.yml Outdated Show resolved Hide resolved
@mickeyryan42 mickeyryan42 force-pushed the mickey/NR-305852-quickstart-ids branch from fff1b4c to 7214731 Compare September 12, 2024 14:03
d3caf
d3caf previously approved these changes Sep 12, 2024
Copy link
Contributor

@d3caf d3caf left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tested it out e2e on my fork and worked as expected 👍

@d3caf
Copy link
Contributor

d3caf commented Sep 12, 2024

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

@@ -15,3 +15,16 @@ jobs:
uses: "./.github/actions/bootstrap"
- name: Validate PR Artifact
uses: "./.github/actions/build-validate-artifact"
validate-quickstart-ids:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

question about the pipeline on this:

Will this run before or after we generate a UUID for a new quickstart? We have a workflow that generates after the quickstart has been merged through.

Not sure if now with the changes it happens on pr -> release branch or if its still ran on release -> pr

@josephgregoryii
Copy link
Contributor

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
Copy link
Contributor Author

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
Copy link
Contributor

d3caf commented Sep 12, 2024

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.

@mickeyryan42 mickeyryan42 merged commit 38dd155 into release Sep 12, 2024
19 checks passed
@mickeyryan42 mickeyryan42 deleted the mickey/NR-305852-quickstart-ids branch September 12, 2024 17:30
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 this pull request may close these issues.

3 participants