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

Gradle Wrapper Validation #611

Merged
merged 2 commits into from
Nov 27, 2022
Merged

Gradle Wrapper Validation #611

merged 2 commits into from
Nov 27, 2022

Conversation

oguzkocer
Copy link
Contributor

Description

In Automattic/a8c-ci-toolkit-buildkite-plugin#34 we introduced our own script to validate the Gradle Wrapper which uses the official documentation for its implementation. This PR uses that script to add a prerequisite step to validate the Gradle Wrapper in both pipelines.

The main reason we decided to add our own script as opposed to using the official Github Action was to be able to validate the Gradle Wrapper before running any of the Buildkite steps. As discussed in that PR, there are some edge cases our script doesn't cover. Furthermore, because it's a custom implementation, there is always a chance that it gets outdated. Therefore, we are adding the official Github Action alongside our own script.

After this PR is merged, I suggest we add the Github Action as a required step for trunk branch. The Buildkite step is already a prerequisite for the rest of the steps, so I don't think we need to add it as a required check, but having the Github Action as a required check should give us some extra peace of mind. Github only takes ~20s to validate the wrapper, so it shouldn't block developers unless there is an issue with it.

Testing Instructions

Verify that the Gradle Wrapper Validation is added as a prerequisite step to the Buildkite pipeline.

Screen Shot 2022-11-24 at 1 44 14 AM

Checklist

  • If this is a user-facing change, I have added an entry in CHANGELOG.md
  • I have considered whether it makes sense to add tests for my changes
  • All strings that need to be localized are in modules/services/localization/src/main/res/values/strings.xml
  • Any jetpack compose components I added or changed are covered by compose previews

I have tested any UI changes...

  • with different themes
  • with a landscape orientation
  • with the device set to have a large display and font size
  • for accessibility with TalkBack

@oguzkocer oguzkocer added the [Type] Tooling Related to the Gradle build scripts and the setup or maintenance of the project build process. label Nov 24, 2022
@oguzkocer oguzkocer added this to the 7.28 milestone Nov 24, 2022
@oguzkocer oguzkocer requested a review from a team November 24, 2022 06:45
@oguzkocer oguzkocer requested a review from a team as a code owner November 24, 2022 06:45
@CLAassistant
Copy link

CLAassistant commented Nov 24, 2022

CLA assistant check
All committers have signed the CLA.

@ParaskP7 ParaskP7 self-assigned this Nov 24, 2022
Copy link
Contributor

@ParaskP7 ParaskP7 left a comment

Choose a reason for hiding this comment

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

👋 @oguzkocer !

Great work on the adding the Gradle Wrapper Validation checks in Pocket Casts Android! 🥇 ❤️ 🚀

I've reviewed and tested the PR as per the description and although everything LGTM I can't access neither the Actions tab, nor the Buildkite page, thus I am just commenting for now, without approving this change:

  • Configuration Changes ✅
  • Buildkite ⚠️
  • GitHub Actions ⚠️

Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.

This might be related to the CLAssistant, but I am not sure... 🤔 Cc @leandroalonso

After this PR is merged, I suggest we add the Github Action as a required step for trunk branch.

I totally agree! 💯

@oguzkocer
Copy link
Contributor Author

@Automattic/pocket-casts-android Can I sign the CLA agreement without having to connect my Github account? We also need someone from the team to review & merge this. Thanks!

@oguzkocer oguzkocer merged commit 047746a into main Nov 27, 2022
@oguzkocer oguzkocer deleted the add/gradle-wrapper-validation branch November 27, 2022 22:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Type] Tooling Related to the Gradle build scripts and the setup or maintenance of the project build process.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants