CHANGE trigger action changes

Q42 · Jul 30, 2024 · 38ac35c · 38ac35c
1 parent e1fd5fe
commit 38ac35c
Show file tree

Hide file tree

Showing 3 changed files with 25 additions and 8 deletions.
diff --git a/.github/workflows/_prepare.yml b/.github/workflows/_prepare.yml
@@ -7,13 +7,18 @@ on:
 
 jobs:
   build:
-    runs-on: [ self-hosted, macOS ] # we host on our own mac mini, it's twice as fast as hosting on github
-    permissions:
+
+
+    # we host on our own mac mini, it's twice as fast and cheaper than hosting on a github runner. See README for more info.
+    runs-on: [ self-hosted, macOS ]
+
+    permissions: # TODO still needed?
       packages: read
       contents: read
 
     steps:
-      - name: Checking out branch
+
+      - name: Checking out branch, needed for the self-hosted runner...
         uses: actions/checkout@v3
 
       - name: Setup Java

diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -11,9 +11,14 @@ on:
 
 jobs:
   build:
-    runs-on: [ self-hosted, macOS ] # we host on our own mac mini, it's twice as fast
+    # we host on our own mac mini, it's twice as fast and cheaper than hosting on a github runner. See README for more info.
+    runs-on: [ self-hosted, macOS ]
 
     steps:
+
+      - name: Checking out branch, needed for the self-hosted runner...
+        uses: actions/checkout@v3
+
       - name: Prepare build
         uses: ./.github/workflows/_prepare.yml
 

diff --git a/README.MD b/README.MD
@@ -40,13 +40,20 @@ you.
 
 ### CI
 
-This project uses Github Actions for CI. We have to workflows setup:
+This project uses Github Actions for CI.
 
-- debug: runs on commits to any branch and creates debug builds
-- release: runs on PR creation and PR changes and creates signed release builds
-- upload: runs on changes to develop (merged PRs), uploads to firebase
+We run on our own mac mini, because this is twice as
+fast as using Github hosted runners (and a lot
+cheaper). [The documentation is in Notion](https://www.notion.so/q42/GitHub-Actions-CI-op-onze-self-hosted-runner-Mac-Mini-7f7d2e6312444b98be521394223db6e2)
+
+We have these workflows:
+
+- debug: runs on commits to any branch and creates debug builds only.
+- release: runs on PR creation and PR changes and creates signed release builds.
+- upload: runs on changes to develop (merged PRs), uploads to Firebase distribution.
 
 TODO: add instructions for uploading an app specific signing key to Github secrets.
+TODO: add instructions for firebase distributon (or removing it).
 
 #### Removing Github Actions