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

Convert dependency check annotation from h3 to p #1663

Open
wants to merge 4 commits into
base: trunk
Choose a base branch
from

Conversation

mokagio
Copy link
Contributor

@mokagio mokagio commented Sep 19, 2024

An h3 (### markdown) in the CI annotation results in a message that clashes visually with the rest of the annotations.

See for example https://buildkite.com/automattic/simplenote-ios/builds/1146

Before
image

After via editing the HTML source in the page. No build run with this yet.
image

Test

We'll see this in action on the next code freeze.

Review

Only one infrastructure developer required to review these changes, but anyone can perform the review.

Release

These changes do not require release notes.

@mokagio mokagio added this to the 4.55 milestone Sep 19, 2024
@mokagio mokagio added the tooling Related to anything that supports the building & maintaining of the project. label Sep 19, 2024
@mokagio mokagio marked this pull request as ready for review September 19, 2024 02:44
buildkite_annotate(context: 'pods-check', style: style, message: message) if is_ci
return unless is_ci

all_dependencies_stable = result[:pods].nil? || result[:pods].empty?
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I did this tidy because I thought I'd add an emoji an wanted to DRY the check.

I decided not to add the emoji to the text because Buildkite already has icons and colors for each annotation style. But I kept the code like this because I think it's a tiny readability improvements.

Also, since I'm on my way to write more commentary than code, I considered being explicit in the variable names and the message in mentioning CocoaPods. But, I'd say leaving it as generic "dependencies" makes it easier for us to update the logic to incorporate something that parses the Package.resolved JSON looking for dependencies that point to non stable versions.

@wpmobilebot
Copy link
Collaborator

wpmobilebot commented Sep 19, 2024

Simplenote Prototype Build📲 You can test the changes from this Pull Request in Simplenote Prototype Build by scanning the QR code below to install the corresponding build.
App NameSimplenote Prototype Build Simplenote Prototype Build
Build Numberpr1663-bdc664e-0192082e-dc25-47d5-a033-6519cb0a760e
Version4.54
Bundle IDcom.codality.NotationalFlow.Alpha
Commitbdc664e
App Center BuildSimplenote - Installable Builds #385
Automatticians: You can use our internal self-serve MC tool to give yourself access to App Center if needed.

fastlane/lanes/release.rb Outdated Show resolved Hide resolved
@mokagio mokagio requested a review from a team September 19, 2024 02:49
Copy link
Contributor

@AliSoftware AliSoftware left a comment

Choose a reason for hiding this comment

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

WFM, but you'll have to update the wording of the task referencing that annotation in the ReleaseV2 scenario to match, now that the annotation has a different "title":

image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
tooling Related to anything that supports the building & maintaining of the project.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants