fix Percy workflows not running correctly in multi-label case

jmuzina commented 1 week ago

Done

Fixes Percy tests not being run properly against PRs with multiple labels.

The array of label names was being converted to "Array" and my if checks were failing. I quoted the conditionals on the jobs, converted them to JSON, and also removed the dependence on a repo variable for the label name.

QA

Review comments / action runs on test PR: https://github.com/jmuzina/vanilla-framework/pull/23
Verify labeled workflow was run against this PR while it had the Percy needed label: https://github.com/canonical/vanilla-framework/actions/runs/9650404273

Check if PR is ready for release

If this PR contains Vanilla SCSS code changes, it should contain the following changes to make sure it's ready for the release:

[x] PR should have one of the following labels to automatically categorise it in release notes:
- Feature 🎁, Breaking Change 💣, Bug 🐛, Documentation 📝, Maintenance 🔨.
[ ] Vanilla version in package.json should be updated relative to the most recent release, following semver convention:
- if CSS class names are not changed it can be bugfix relesase (x.x.X)
- if CSS class names are changed/added/removed it should be minor version (x.X.0)
- see the wiki for more details
[ ] Any changes to component class names (new patterns, variants, removed or added features) should be listed on the what's new page.

webteam-app commented 1 week ago

Demo

Jenkins

demos.haus

bartaz commented 1 week ago

Not sure if I understand what was wrong, and why changing array to JSON fixes it, but if that works I'm good.

jmuzina commented 1 week ago

Not sure if I understand what was wrong, and why changing array to JSON fixes it, but if that works I'm good.

@bartaz

It's not entirely clear to me either - from what I was seeing, this was working in initial tests of the PR, then stopped working when multiple labels were applied to real PRs. I whipped this up as a quick / heavy-handed fix so that our live PRs can get Percy tested, but it can get a more thorough re-look later if needed.

My current best guess is it's something to do with how the array of names is serialized with respect to contains(), or maybe it's just that I quoted the label name with this PR and it wasn't quoted when using the variable. However contains() is supposed to work with arrays out of the box.

So this is converting the array of names into a string, and performing a substring match to find the quoted Percy label.

bartaz commented 1 week ago

Changing label from Bug to Maintenance, as it's not a bug in Vanilla codebase (so doesn't need to be featured as a bugfix for consumers of Vanilla).

canonical / vanilla-framework