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.

Sign up for GitHub

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

PLAYNEXT-500 Improve release workflow #519

Merged
merged 15 commits into from
Sep 29, 2024
Merged

PLAYNEXT-500 Improve release workflow #519

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
c2637eb
PLAYNEXT-500 Check tag_version is not empty from CI
pyby Sep 28, 2024
f666f98
PLAYNEXT-500 Factorise tag_version from options
pyby Sep 28, 2024
c553408
PLAYNEXT-500 Update CI AppStore release documentation
pyby Sep 28, 2024
ae5888e
PLAYNEXT-500 Add an existing tag check before submitting to Apple review
pyby Sep 29, 2024
67c6c98
PLAYNEXT-500 Fix logic
pyby Sep 29, 2024
10135c9
PLAYNEXT-500 Rename After AppStore release lane
pyby Sep 29, 2024
af505e7
PLAYNEXT-500 Publish release note update from github deployment status
pyby Sep 29, 2024
9560c64
PLAYNEXT-500 Fix condition
pyby Sep 29, 2024
043e750
PLAYNEXT-500 Update documentation
pyby Sep 29, 2024
ad8d7b1
PLAYNEXT-500 Update logs
pyby Sep 29, 2024
2929bd0
PLAYNEXT-500 Improve workflow documenation
pyby Sep 29, 2024
f505a80
PLAYNEXT-500 Add table of content in workflow page
pyby Sep 29, 2024
2512c22
PLAYNEXT-500 Document App Store release status worflow
pyby Sep 29, 2024
e85fdb7
PLAYNEXT-500 Add sequence diagram for release notes on Github pages
pyby Sep 29, 2024
d2af5c7
PLAYNEXT-500 Add table of content on main read me
pyby Sep 29, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ If you are not sure about the likelihood of a change you propose to be accepted,
Templates are available when you want to contribute:

* [Issues](https://github.com/SRGSSR/playsrg-apple/issues): Please follow our issue template. You can omit information which does not make sense but, in general, the more details you can provide, the better. This ensures we can quickly reproduce the problem you are facing, increasing the likelihood we can fix it.
* [Pull requests](https://github.com/SRGSSR/playsrg-apple/pulls): Please follow our code conventions and [workflows](WORKFLOWS.md), test your code well, and write unit tests when this makes sense. We will review your work and, if successful, merge it back into the main development branch.
* [Pull requests](https://github.com/SRGSSR/playsrg-apple/pulls): Please follow our [code conventions](#code-conventions) and [workflows](WORKFLOWS.md), test your code well, and write unit tests when this makes sense. We will review your work and, if successful, merge it back into the main development branch.

## Code conventions

Expand Down
52 changes: 32 additions & 20 deletions docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,21 @@
![SRG Media Player logo](README-images/logo.png)

- [About](#about)
- [Features](#features)
- [Compatibility](#compatibility)
- [Required tools](#required-tools)
- [Building the project](#building-the-project)
- [Project setup](#project-setup)
- [Private settings](#private-settings)
- [Running the project](#running-the-project)
- [Quality checks](#quality-checks)
- [Git hooks installation](#git-hooks-installation)
- [Licenses for libraries](#licenses-for-libraries)
- [Translations](#translations)
- [Contributing](#contributing)
- [Releasing binaries](#releasing-binaries)
- [Documentations](#documentations)

## About

Play SRG is the [SRG SSR (Swiss Broadcasting Corporation)](https://www.srgssr.ch/en/who-we-are/organisation/) audio and video platform, provided as a distinct service for each of its business units ([RSI](https://www.rsi.ch), [RTR](https://www.rtr.ch), [RTS](https://www.rts.ch), [SRF](https://www.srf.ch) and [SWI](https://www.swissinfo.ch)). This repository contains the source code of the Play SRG applications for iOS and tvOS.
Expand Down Expand Up @@ -113,18 +129,6 @@ make check-quality

This ensures that Swift files, and scripts are conform to common best practices.

### Licenses for libraries used in the project

In the iOS application settings, licenses of libraries used in the project can be consulted. To build the list, running an iOS target requires [LicensePlist](https://github.com/mono0926/LicensePlist).

```
brew install licenseplist
```

### SRGSSR project

Some links to [internal Jira SRGSSR instance](https://srgssr-ch.atlassian.net) can be found in commit messages, branch names or pull request titles.

### Git hooks installation

Project git hooks can be installed to help quality checks and commit messages for internal SRGSSR project. Install them by running the following command:
Expand All @@ -133,13 +137,17 @@ Project git hooks can be installed to help quality checks and commit messages fo
make git-hook-install
```

## Contributing
### Licenses for libraries

If you want to contribute to the project as an external contributor, have a look at our [contributing guide](CONTRIBUTING.md).
In the iOS application settings, licenses of libraries used in the project can be consulted. To build the list, running an iOS target requires [LicensePlist](https://github.com/mono0926/LicensePlist).

## Translations
```
brew install licenseplist
```

Translation tool is [crowdin.com](https://crowdin.com/project/play-srg). The following scripts need [Crowdin CLI](https://crowdin.github.io/crowdin-cli/).
### Translations

Translation tool is [crowdin.com](https://crowdin.com/project/play-srg). The following scripts need [Crowdin CLI](https://crowdin.github.io/crowdin-cli/) and a private token.

- Review new source translation files in `Translations` folder:

Expand All @@ -159,6 +167,10 @@ Translation tool is [crowdin.com](https://crowdin.com/project/play-srg). The fol
make pull-translations
```

## Contributing

If you want to contribute to the project as an external contributor, have a look at our [contributing guide](CONTRIBUTING.md) and our [workflows](WORKFLOWS.md).

## Releasing binaries

The proprietary project uses [fastlane](https://fastlane.tools/) to release binaries either for internal purposes or for the App Store to release binaries.
Expand All @@ -169,12 +181,12 @@ A [github page](https://srgssr.github.io/playsrg-apple/) with release notes page

See [release checklist](RELEASE_CHECKLIST.md) for App Store release details.

## Specifications
## Documentations

Follow the links below for feature specifications and technical details:

* [Configuration files](CONFIGURATION_FILES.md)
* [Remote configuration](REMOTE_CONFIGURATION.md)
* [Custom URL and Universal Link Support](CUSTOM_URLS_AND_UNIVERSAL_LINKS.md)
* [Push notifications](PUSH_NOTIFICATIONSSS.md)
* [Push notifications](PUSH_NOTIFICATIONS.md)
* [Remote configuration](REMOTE_CONFIGURATION.md)
* [Configuration files](CONFIGURATION_FILES.md)
* [Github environments and deployments](GITHUB_ENVIRONMENTS_AND_DEPLOYMENTS.md)
124 changes: 105 additions & 19 deletions docs/WORKFLOWS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,26 @@
# Workflows
# Workflows<!-- omit from toc -->

The project implements some workflows. It a mix of:

- Fastlane scripts (needs `make ruby-setup` to setup Ruby).
- Bash scripts (with `make` commands).
- Fastlane scripts (mostly running on an [on premise TeamCity instance](https://playcity.eu.ngrok.io/project/playsrgios) but can be run locally as well).
- Bash scripts (locally with `make` commands).
- Github actions (running on [github.com](https://github.com/SRGSSR/playsrg-apple)).

### Table of Contents
- [Start a feature or a bug fix](#start-a-feature-or-a-bug-fix)
- [Start from an internal Jira ticket](#start-from-an-internal-jira-ticket)
- [Start from a public Github issue](#start-from-a-public-github-issue)
- [Build and distribute Private Nightlies](#build-and-distribute-private-nightlies)
- [Submit to review a feature or a bug fix](#submit-to-review-a-feature-or-a-bug-fix)
- [Build and distribute Private Betas](#build-and-distribute-private-betas)
- [Build and distribute Public Betas and AppStore Builds](#build-and-distribute-public-betas-and-appstore-builds)
- [Prepare an App Store release](#prepare-an-app-store-release)
- [Update the App Store screenshots](#update-the-app-store-screenshots)
- [Submit an App Store release for review](#submit-an-app-store-release-for-review)
- [Follow App Store release status](#follow-app-store-release-status)
- [Release notes on Github pages](#release-notes-on-github-pages)
- [Bump platform version after a release](#bump-platform-version-after-a-release)

# Start a feature or a bug fix

🙏 Please first run one time on the Mac, `make git-hook-install`, so that the `pre-commit` linter and Jira `commit-msg` are installed.
Expand Down Expand Up @@ -250,14 +265,15 @@ On [crowdin.com PlaySRG project](https://crowdin.com/project/play-srg/sources/fi
5. On PlayCity CI select the project:
- **[Play SRG iOS AppStore releases](https://playcity.eu.ngrok.io/buildConfiguration/playsrgios_PlaySrgIOSAppStoreReleases)**: `fastlane ios iOSPrepareAppStoreReleases`
- **[Play SRG tvOS AppStore releases](https://playcity.eu.ngrok.io/buildConfiguration/playsrgios_PlaySrgTvOSAppStoreReleases)**: `fastlane ios tvOSPrepareAppStoreReleases`
6. Select the commit with the tag.
7. Run the project. The script:
6. "Run" the project to open the dialog view.
7. In the *Parameters* tab, set the `tag_version` parameter (`X.Y.Z-N`) to use, if the version on `main` branch is not the expected one (**should not be the case**).
8. "Run build" from the dialog view. The script:
- Creates a new App Store release on App Store Connect with the current version if not already existing.
- Sets the translated what's new for this version.
- Updates the what's new App Store release notes with the translated release notes from crowdin.com.
- Does basic checks with [Fastlane precheck](https://docs.fastlane.tools/actions/precheck/).
- Does some basic metadata checks with [Fastlane precheck](https://docs.fastlane.tools/actions/precheck/).
- No submission to Apple review is done for now.
8. We can follow Apple release status and what's new release notes locally with `make appstore-status`.
9. We can follow Apple release status and what's new release notes locally with `make appstore-status`.

ℹ️ The project can be rerun to update the translated App Store release notes if needed.

Expand Down Expand Up @@ -328,16 +344,65 @@ Let's submit the App Store release for review:
2. On PlayCity CI select the project:
- **[Play SRG iOS AppStore releases](https://playcity.eu.ngrok.io/buildConfiguration/playsrgios_PlaySrgIOSAppStoreReleases)**: `fastlane ios iOSPrepareAppStoreReleases submit_for_review:true`
- **[Play SRG tvOS AppStore releases](https://playcity.eu.ngrok.io/buildConfiguration/playsrgios_PlaySrgTvOSAppStoreReleases)**: `fastlane ios tvOSPrepareAppStoreReleases submit_for_review:true`
3. Select the commit with the tag.
4. Check the `submit_for_review` parameter.
5. Run the project. The script:
3. "Run" the project to open the dialog view.
4. In the *Parameters* tab, check the `submit_for_review` parameter.
5. In the *Parameters* tab, set the `tag_version` parameter (`X.Y.Z-N`) to use, if the version and build number on `main` branch are not the expected one (**should be the case**).
6. "Run build" from the dialog view. The script:
- Creates a new App Store release on App Store Connect with the current version if not already existing.
- Sets the translated what's new for this version.
- Updates the what's new App Store release notes with the translated release notes from crowdin.com.
- Does basic checks with [Fastlane precheck](https://docs.fastlane.tools/actions/precheck/).
- The latest build related to the version is submitted to Apple review (highest build number).
- Does some basic metadata checks with [Fastlane precheck](https://docs.fastlane.tools/actions/precheck/).
- The build related to the tag version is submitted to Apple review (build number from the `tag_version` parameter in the dialog view).
- 🚀 Submission to Apple review is done this time.
6. We can follow Apple release status and what's new release notes locally with `make appstore-status`.
- *Automatically release this version* is set, to automatically release it after it has been approved by Apple App Review.
7. We can follow Apple release status and what's new release notes locally with `make appstore-status`.

# Follow App Store release status

Now, it's in Apple App Review team hands. Any Apple Ids linked to applications on App Store Connect will receive by email status update.

Locally, on a Mac, running `make appstore-status` give the current status for all Play SRG applications on App Store Connect.

ℹ️ The script is also scheduled to run on CI automatically.

1. On PlayCity CI select the project:
- **[Play SRG AppStore status](https://playcity.eu.ngrok.io/buildConfiguration/playsrgios_PlaySrgAppStoreStatus)**: `fastlane ios appStoreAppStatus github_deployments:true publish_release_notes:true`
2. Select the `main` branch (should be already selected).
3. Run the project. The script:
- Gets AppStore live versions.
- Gets lastest AppStore versions (can be the new submitted one or the live one).
- checkes that the lastest AppStore version is different as the live version. Then the script:
- Updates Github production deployment according to the last AppStore release state.
- Displays in the console, live and latests versions, build number , current release state, and what's new.
- Runs `fastlane ios publishReleaseNotes` if a Github production deployment state has switched to `success`. (see [Release notes on Github pages](#release-notes-on-github-pages))

```mermaid
---
title: Follow App Store release status
---
sequenceDiagram
participant Fastlane
participant ASC as App Store Connect
Fastlane->>ASC: Ask live version
activate Fastlane
activate ASC
ASC-->>Fastlane: Get live version
deactivate ASC
Fastlane->>Github: Ask production deployment state
activate Github
Github-->>Fastlane: Get production deployment state
deactivate Github
Fastlane->>Github: Update production deployment state if needed
Fastlane->>ASC: Ask latest version
activate ASC
ASC-->>Fastlane: Get latest version
deactivate ASC
Fastlane->>Github: Update production deployment state if needed
Fastlane->>Github: Push new gh-page with release notes if needed
deactivate Fastlane
```

ℹ️ To learn more about Github deployments, see [Github environments and deployments](GITHUB_ENVIRONMENTS_AND_DEPLOYMENTS.md).

# Release notes on Github pages

Expand All @@ -346,13 +411,15 @@ It downloads a html file to display release notes. The html pages are published

Publish release notes on Github pages with correct released status (App Store and TestFlight release notes):

ℹ️ The script is scheduled to run on CI after a private or public beta build success.
ℹ️ The script is scheduled to run on CI after a private or public beta build success, also when an AppStore release is found with the [Play SRG AppStore status](https://playcity.eu.ngrok.io/buildConfiguration/playsrgios_PlaySrgAppStoreStatus) check.

1. On PlayCity CI select the project:
- **[Play SRG Publish release notes](https://playcity.eu.ngrok.io/buildConfiguration/playsrgios_PlaySrgPublishReleaseNotes)**: `fastlane ios publishReleaseNotes`
2. Run the project. The script:
- Does the `gh-pages` branch update automatically.
- Can be from any branch. No dependency with versions or build numbers.
- Gets translated whats's new from Crowdin.
- Gets live version from App Store Connect.
- Force pushes updated pages to the `gh-pages` branch.
- Can be run from any branch. No dependency with versions or build numbers.

The update can be done manually (not recommended), without keeping the commits history on the `gh-pages` branch:

Expand All @@ -364,22 +431,41 @@ The update can be done manually (not recommended), without keeping the commits h
- Switch back to another branch.
- Remove local `gh-pages` branch (recommended if the fastlane script needs to run later).

# Bump versions
```mermaid
---
title: Release notes on Github pages
---
sequenceDiagram
Fastlane->>Crowdin: Ask what's new translated csv files
activate Fastlane
activate Crowdin
Crowdin-->>Fastlane: Get what's new translated csv files
deactivate Crowdin
participant ASC as App Store Connect
Fastlane->>ASC: Ask live version
activate Fastlane
activate ASC
ASC-->>Fastlane: Get live version
deactivate ASC
Fastlane->>Github: Publish new gh-pages
deactivate Fastlane
```

# Bump platform version after a release

When a release is published on the App Store, the version number (`X.Y.Z`) needs to be bumped for the next release.

ℹ️ The script is scheduled to run on CI automatically.

1. On PlayCity CI select the project:
- **[Play SRG After AppStore validation](https://playcity.eu.ngrok.io/buildConfiguration/playsrgios_PlaySrgAfterAppStoreValidation)**: `fastlane ios afterAppStoreValidation`
- **[Play SRG After AppStore release](https://playcity.eu.ngrok.io/buildConfiguration/playsrgios_PlaySrgAfterAppStoreRelease)**: `fastlane ios afterAppStoreRelease`
2. Select the `main` branch (should be already selected).
3. Run the project. The script:
- Get AppStore live versions.
- If one live version is same as the current marketing version, the script:
- Bumps the patch number of version number (`X.Y.Z`) on the repository.
- Commits the version bump with message "Bump version to `X.Y.Z+1`".
- Pushes the commit to the repository.
- Runs `fastlane ios publishReleaseNotes` if a marketing version as been bumped.

```mermaid
---
Expand Down
Loading