Setup CI

[defagos]

• [x] Setup private configuration repository
• [x] Setup project version and local xcconfig files
• [x] Ensure bundle id / name reflect nightly builds (name, emoji)
• [x] Add Fastlane support
• [x] Create nightly and beta app on TestFlight
• [x] Create automatic release notes
• [x] Setup project on TeamCity
• [x] Ensure test reports can be properly browsed on TeamCity
• [x] Ensure test reports are properly cleaned at start so that each run delivers its associated results only
• [x] Add badges to icons with fastlane
• [x] See if integrating Danger is valuable (e.g. spellchecking, UT result, check for print statements, etc.)
• [x] Post UT status to PR.
• [x] ~Integrate Jazzy~
• [x] ~Implement command to add testers from fastlane~
• [x] Document Makefile local use and CI integration
• [x] Ensure the project works without private configuration

[defagos]

Danger can be used to report UT failure directly in GitHub comments. Some useful resources:

• https://github.com/danger/swift
• https://github.com/danger/awesome-danger
• https://pspdfkit.com/blog/2016/converting-xcode-test-results-the-fast-way
• https://www.inovex.de/de/blog/automatic-quality-assurance-measures-ios-tvos-fastlane-danger-swiftlint
• https://github.com/danger/danger/blob/master/lib/danger/ci_source/teamcity.rb
• https://www.youtube.com/watch?v=4yFck9PvXI4
• https://medium.com/kinandcartacreated/your-guide-to-danger-swift-on-ci-83e3f5136a9a#a5f1
• https://github.com/danger/danger/issues/834

Since we are in a self-hosted CI scenario we need to:

• Make PRs build on the CI (maybe likely only run tests on them).
• Find the PR number.
• Provide it to Danger.

See CI setup for the variables to provide.

[defagos]

I didn't clean the previous reports but pointed at the correct JUnit output instead.

[defagos]

To document for Danger integration:

• Creation of an GitHub access token.
• Write access to repo (if private).

[defagos]

Required on TeamCity before running Danger:

export GITHUB_REPO_SLUG=SRGSSR/pillarbox-apple
export GITHUB_REPO_URL=https://github.com/SRGSSR/pillarbox-apple
export GITHUB_PULL_REQUEST_ID=4

PR must be dynamic, of course.

The PR might be retrieved directly with teamcity.pullRequest.number but this might require special care when configuring the pull request plugin.

[defagos]

Jazzy is a bit too old to be integrated. Skipped.

[defagos]

I could not make spellchecking with proselint and mdspell work because of version conflicts. Skipped.

[defagos]

Using bundle install --path vendor/bundle is deprecated but the suggested replacement, namely setting bundle config set --local path 'vendor/bundle' first, leads to issues with fastlane:

bundler: failed to load command: fastlane (/Users/defagos/Developer/repositories/pillarbox-apple/vendor/bundle/ruby/3.1.0/bin/fastlane)
/Users/defagos/Developer/repositories/pillarbox-apple/vendor/bundle/ruby/3.1.0/gems/fastlane-2.208.0/fastlane/lib/fastlane/junit_generator.rb:13:in `read': No such file or directory @ rb_sysopen - /Users/defagos/Developer/repositories/pillarbox-apple/vendor/bundle/ruby/3.1.0/gems/fastlane-2.208.0/fastlane/lib/assets/report_template.xml.erb (Errno::ENOENT)

So for the moment I used neither.

[defagos]

Won't add a command to register testers, not so cumbersome and can be done with pilot if later needed.