Make Fastlane the single source of truth for release notes

mokagio commented 2 months ago

Following up on what discussed at in https://github.com/Automattic/simplenote-ios/pull/1639#discussion_r1718251107. Also see internal ref pdnsEh-1Qv-p2.

Removes Simplenote/Resources/release_notes.txt and uses fastlane/metadata/default/release_notes.txt as the single source of truth for release notes to send to localization.

Implementation considerations

Ignore fastlane/metadata/default/release_notes.txt? (No) I briefly considered not tracking the file under Git because we generate it from RELEASE-NOTES.txt. I discarded that option because RELEASE-NOTES.txt contains "raw" release notes, or, let's say, release notes formatted for an audience of developers. The release notes in fastlane/metadata/default/release_notes.txt on the other hand, should be formatted for users to read.

Ignore `fastlane/metadata//release_notes.txt? (No)** When implementing the code to deleted the previous localizedrelease_notes.txt` entries and commit the result I also wondered whether we wouldn't be better served by Git-ignoring those files and downloading them from GlotPress when it's time to update the metadata on ASC. I decided against that for two reasons:

When creating hotfixes, GlotPress might have already been updated with the new notes and no longer have the ones we need. Having the localizations in the repo ensures we can easily reuse the release notes for the version which the hotfix targets
It's handy to have the localizations show in the diff to "smoke test" them. There have been various occasions in the past where release managers noticed issues in the release notes this way.

Other pieces to update?

We don't need to update the GlotPress upload cron job because it reads the .pot file, which has not moved.
I decided not to update the script that generates the release checklist for this app in favor of deleting it because of the migration to our internal GUI tool.
Our internal GUI tool will need to be updated to 1) use the new path in the user facing instructions; 2) use the new path in the setting that the automation to generate the announcement post uses (I'll need @hannahtinkler guidance to find it)

Test

I created a test branch on top of this one, hacked code_freeze to run the automation and verified the results. See XXX

Review

Only one infra engineer required to review these changes, but anyone can perform the review.

Release

These changes do not require release notes.

dangermattic commented 2 months ago

	1 Warning
:warning:	This PR is assigned to the milestone 4.53. 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

wpmobilebot commented 2 months ago

📲 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 Name	Simplenote Prototype Build
	Build Number	pr1647-bf66628-0191ba26-bb74-4e1e-8aa5-0ba699cbb283
	Version	4.52
	Bundle ID	com.codality.NotationalFlow.Alpha
	Commit	bf666288471c27569fa35aa72263431fc5c9e73f
	App Center Build	Simplenote - Installable Builds #346

Automatticians: You can use our internal self-serve MC tool to give yourself access to App Center if needed.

AliSoftware commented 2 months ago

Ignore fastlane/metadata/**/release_notes.txt? (No)

A 3rd reason I like for not git-ignoring those is simple so that they are tracked in git. So we can see what translations were used in an old commit and have the history.

mokagio commented 2 months ago

Thanks for the suggestions @AliSoftware. Addressed via 439bc6c9

Automattic / simplenote-ios