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

Gutenberg: Move config comments to header #21872

Merged
merged 3 commits into from
Oct 25, 2023

Conversation

jhnstn
Copy link
Member

@jhnstn jhnstn commented Oct 24, 2023

Currently the yq command removes the nested comments when evaluating del(.ref.tag). This occurs when preparing a new Gutenberg Mobile release (see here)

Here is an example of the comments being removed 084669a

This seems to be a common issue with yq but for our case, moving the comments to the header of the file avoids the deletion.

To test:

Try updating the commit value and removing the tag field via yq:

  • yq eval ".ref.commit = \"123abc\"" ./Gutenberg/config.yml -i
  • yq eval 'del(.ref.tag)' ./Gutenberg/config.yml -i

Note that the comments are not removed after either command

Regression Notes

  1. Potential unintended areas of impact:

Gutenberg releases

  1. What I did to test those areas of impact (or what existing automated tests I relied on)

Manually testing the yq commands used to update Gutenberg

  1. What automated tests I added (or what prevented me from doing so)

Change is too small to warrant automated tests

PR submission checklist:

  • I have completed the Regression Notes.
  • I have considered adding unit tests for my changes.
  • I have considered adding accessibility improvements for my changes.
  • I have considered if this change warrants user-facing release notes and have added them to RELEASE-NOTES.txt if necessary.

UI Changes testing checklist:

  • Portrait and landscape orientations.
  • Light and dark modes.
  • Fonts: Larger, smaller and bold text.
  • High contrast.
  • VoiceOver.
  • Languages with large words or with letters/accents not frequently used in English.
  • Right-to-left languages. (Even if translation isn’t complete, formatting should still respect the right-to-left layout)
  • iPhone and iPad.
  • Multi-tasking: Split view and Slide over. (iPad)

@jhnstn jhnstn added the Tooling Build, Release, and Validation Tools label Oct 24, 2023
@jhnstn jhnstn requested review from derekblank and mokagio October 24, 2023 15:23
@peril-wordpress-mobile
Copy link

Warnings
⚠️ PR is not assigned to a milestone.

Generated by 🚫 dangerJS

@wpmobilebot
Copy link
Contributor

wpmobilebot commented Oct 24, 2023

WordPress Alpha📲 You can test the changes from this Pull Request in WordPress Alpha by scanning the QR code below to install the corresponding build.
App NameWordPress Alpha WordPress Alpha
ConfigurationRelease-Alpha
Build Numberpr21872-f4ed12a
Version23.5
Bundle IDorg.wordpress.alpha
Commitf4ed12a
App Center BuildWPiOS - One-Offs #7530
Automatticians: You can use our internal self-serve MC tool to give yourself access to App Center if needed.

@wpmobilebot
Copy link
Contributor

wpmobilebot commented Oct 24, 2023

Jetpack Alpha📲 You can test the changes from this Pull Request in Jetpack Alpha by scanning the QR code below to install the corresponding build.
App NameJetpack Alpha Jetpack Alpha
ConfigurationRelease-Alpha
Build Numberpr21872-f4ed12a
Version23.5
Bundle IDcom.jetpack.alpha
Commitf4ed12a
App Center Buildjetpack-installable-builds #6557
Automatticians: You can use our internal self-serve MC tool to give yourself access to App Center if needed.

@jhnstn jhnstn enabled auto-merge October 24, 2023 18:40
@derekblank derekblank disabled auto-merge October 25, 2023 04:43
Copy link
Contributor

@derekblank derekblank left a comment

Choose a reason for hiding this comment

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

LGTM - I was able to follow the testing instructions successfully and noted that the comments were not removed when changing the commit value and removing the tag via yq. Disabling automerging for now to let @mokagio confirm if moving the comments to the header might affect anything else unintentionally.

Gutenberg/config.yml Outdated Show resolved Hide resolved
@mokagio
Copy link
Contributor

mokagio commented Oct 25, 2023

Thanks @jhnstn @derekblank ! 🙇‍♂️

@mokagio mokagio enabled auto-merge October 25, 2023 04:53
@mokagio mokagio merged commit afa73c4 into trunk Oct 25, 2023
@mokagio mokagio deleted the gutenberg/update-config-comments branch October 25, 2023 05:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Tooling Build, Release, and Validation Tools
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants