search

Automattic / pocket-casts-ios

Pocket Casts iOS app 🎧
Mozilla Public License 2.0
1.66k stars 133 forks source link

[Tooling] Reorder lanes in `Fastfile` #2216

Closed AliSoftware closed 1 month ago

AliSoftware commented 1 month ago

📘 Related to Project Thread: paaHJt-78B-p2

[!IMPORTANT] This PR stacks on top of https://github.com/Automattic/pocket-casts-ios/pull/2215

release-on-ci/reorder-lanes
  |
  |-- [#2216] (this PR)
  v
release-on-ci/refactor-code-freeze
  |
  |-- [#2215]
  v
trunk

What

This PR only moves lanes around in the Fastfile, so that they are listed in the Fastfile in an order that makes more sense and are grouped by topic.

This also adds a couple of ######### header comments to announce groups of lanes that are all related by topic, and adds some YARD doc to a few lanes or helper methods that were missing them.

Review process

I've extracted that move in a dedicated PR on purpose, so that https://github.com/Automattic/pocket-casts-ios/pull/2215 would be easier to review without the moves making the diff difficult to parse.

Thus the changes in this PR are only moves of code/lanes/functions from one place in the Fastfile to another, without changing anything in their code.

💡 If you want to see those moves in a way that would be less obscure than how GitHub presents the diff, to facilitate your review, you might prefer/consider running git diff --color-moved=dimmed-zebra -w release-on-ci/refactor-code-freeze on your Terminal after checking this PR's release-on-ci/reorder-lanes branch, so that the moves are detected by git diff as such and highlighted differently than plain changes/deletions/additions.

[!NOTE] I'd recommend to only merge this PR after https://github.com/Automattic/pocket-casts-ios/pull/2215 has been merged first—otherwise if we merge this PR first, the code moves made in this PR will then be included in https://github.com/Automattic/pocket-casts-ios/pull/2215's diff, thus making its review harder and losing the benefit of having done separate PRs in the first place.

dangermattic commented 1 month ago
2 Warnings
:warning: This PR is larger than 500 lines of changes. Please consider splitting it into smaller PRs for easier and faster reviews.
:warning: This PR is assigned to the milestone 7.74. The due date for this milestone has already passed.
Please assign it to a milestone with a later deadline or check whether the release for this milestone has already been finished.

Generated by :no_entry_sign: Danger