diff --git a/README.md b/README.md index 47f5f0f2..82d15ce5 100644 --- a/README.md +++ b/README.md @@ -14,17 +14,16 @@ 1. Install the Android SDK via the [Android plugin](https://www.jetbrains.com/help/idea/create-your-first-android-application.html#754fd) or Android Studio 2. Install [fvm](https://fvm.app/documentation/getting-started/installation) (flutter version manager) -3. Install [fvm](https://fvm.app/documentation/getting-started/installation) (flutter version manager) -4. Install flutter +3. Install flutter ``` shell fvm install ``` -5. Configure local environment +4. Configure local environment ``` shell cp .env.dev .env ``` -6. [Optional] Adjust the environment variables in `.env` as needed -7. [Optional] Open IntelliJ settings and +5. [Optional] Adjust the environment variables in `.env` as needed +6. [Optional] Open IntelliJ settings and - Install the Android plugin and set the Android SDK path - Install the Dart plugin and set the Dart SDK path - Install the Flutter plugin and set the Flutter SDK path diff --git a/docs/cicd.md b/docs/cicd.md index 226d2875..0d3ed051 100644 --- a/docs/cicd.md +++ b/docs/cicd.md @@ -8,9 +8,9 @@ - [Configuring Secrets](#configuring-secrets) - [Workflows](#workflows) - [Creating a new Release or Promotion](#creating-a-new-release-or-promotion) +- [GitHub Access](#github-access) - [Fastlane](#fastlane) - [App Signing](#app-signing) -- [Versioning](#versioning) ## CI/CD Tech Stack @@ -119,6 +119,18 @@ Usually, the order would be as follows: In special cases (e.g. for an urgent hotfix), releases can be directly delivered to production (ios: distribution) by triggering the `production_delivery` workflow. +### GitHub Access + +CircleCI is configured to use different methods to access GitHub. +- For normal read-only access to this repository, CircleCI automatically adds +a [deploy key](https://github.com/verdigado/gruene_app/settings/keys) during initial setup of CircleCI for the repo. +- For write access to this repository the [VerdigadoBot GitHub app](https://github.com/organizations/verdigado/settings/apps/verdigadobot) is used. It has to be installed in the repo. +CircleCI has access to this app using its private key (set in [contexts](#configuring-secrets)). +The GitHub app is used for version bump commits and the creation of tags and releases. +- For read-only access to additional repos, the GitHub machine user `VerdigadoCI` is used. +CircleCI has access to this user through a [user key](https://app.circleci.com/settings/project/github/verdigado/gruene_app/ssh). +This is used to access the [app-signing](#app-signing) repository. + ## Fastlane We use [Fastlane](https://docs.fastlane.tools) for automating the build and deliver to the app stores.