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

Jump to bottom

docs: add checklist for setting up a new native iOS project #8

Draft
wants to merge 2 commits into
base: develop
Choose a base branch
from
Draft

docs: add checklist for setting up a new native iOS project #8

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ecb625d
docs: add checklist for setting up a new native iOS project
treboc Jul 14, 2023
13c8383
docs: update checklist due to review comments
treboc Jul 16, 2023
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
58 changes: 58 additions & 0 deletions docs/projectSetup/iOS/checklist_iOS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
# iOS Project Setup
## Git
Create new repository based on native-ios-repo-template

## Apple Developer
The Developer Certiciate and Provisioning Profile are required for code signing and distribution.

[Apple Developer Portal](https://developer.apple.com/account/resources/)

1. Load the NanoGiants GmbH iOS Distribution Certificate from our 1Password vault, and add it to your Keychain.
2. Add identifiers for the different environments.
3. Add provisioning profiles for the different environments.

## Xcode
### Create an empty base project in Xcode.
Configure signing & capabilities for different environments.

1. Debug
2. Development
3. Staging
4. Production

### Configure analytics, crash reporting, and static file analysis tools.
1. Integrate Sentry for error tracking.
Copy link
Member

Choose a reason for hiding this comment

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

Please link to the Sentry index docs. Might be helpful here.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I will link to the docs, asap they're merged.

2. Use SonarCloud for code quality analysis.
Copy link
Member

Choose a reason for hiding this comment

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

Same here. Please link to the SonarCloud index docs. Might be helpful as well

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Same here.

3. Use Danger for code review automation.
4. Integrate SwiftLint for code style enforcement.
5. Integrate SwiftGen for code generation.
**TODO**: Add detailed descriptions for each step.

## CI/CD
### AppCenter
1. Log into AppCenter account and create a new project
**Make sure that you create the project under the NanoGiants GmbH group!**
2. Configure the necessary build and distribution settings in AppCenter.
3. Set up distribution group for iOS and add the collaborator group.
4. Invite relevante people if not already in collaborator group.

**Naming:**
Project: `"PROJECT-App-BUILDTYPE"` (e.g. NanoGiants-App-Develop)
DistributionGroup: `"PROJECT-PLATFORM"` (e.g. NanoGiants-iOS)

### Bitrise
1. Create a Bitrise project for continuous integration and deployment.
2. Copy and adjust the base .yaml file into the Bitrise project.
**TODO**: create base .yaml
3. Configure code signing and files in the Bitrise project.
1. Upload the `provisioning profiles`
2. Upload the `code signing certificates`
3. Upload the AppStore AuthKey .p8 file (this)
4. if needed, upload the `.xcconfig`-files for every environment.
**TODO**: link and upload shell script into the repository
4. Manage secrets in Bitrise to securely store sensitive information.
1. AppCenter Token
2. GitHub Access Token
3. Danger API Token
4. SonarToken
5. Appstore API IssuerID