1. Indholdsfortegnelse
2. Introduktion
2.1. Formål
Formålet med dette dokument, er at beskrive systemkrav og opsætning for udviklere på projektet. Desuden beskrive en række værktøjer, der hjælper med udviklingen, som er anvendt i projektet.
2.2. Sammenhæng med øvrige dokumenter
-
3. Udvikling
3.1. Krav for at bygge projektet
For at bygge projektet skal det åbnes i Android Studio (https://developer.android.com/studio - Projektet er senest udviklet og bygget med version 2022.3.1) og derefter vil alle dependencies blive synkroniseret vha. gradle.
Appen bruger JDK 17 og Gradle 8.1.
3.2. NSP Header
I Android Studio (som er en variant af IntelliJ) skal man tilføje NSP's copyright header under Preferences → Editor → Copyright → Copyright Profiles.
For at lave en generisk header som skifter copyright årstal, kan følgende template bruges:
The MIT License
Original work sponsored and donated by The Danish Health Data Authority (http://www.sundhedsdatastyrelsen.dk)
Copyright (C) $originalComment.match("Copyright \(C\) (\d+)", 1, "-")$today.year The Danish Health Data Authority (http://www.sundhedsdatastyrelsen.dk)
Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
of the Software, and to permit persons to whom the Software is furnished to do
so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
Når dette er sat, vil alle filer i projektet få indsat headeren automatisk ved oprettelse af filen. Den påkrævede copyright på filerne bliver også opretholdt ved hjælp af Spotless, som fejler hvis den scanner .kt, .kts eller .xml filer uden headeren.
Copyright headeren som Spotless bruger ligger i mappen spotless/ med versioner til hver af de 3 filtyper som kræver headeren.
spotless
├── copyright.kt
├── copyright.kts
└── copyright.xml
3.3. Tools
Projektet indeholder en række tools, der anvendes under udvikling.
3.3.1. Generering af strings.xml
Alle strings er oprettet i et Localizely projekt (Claus Leth Gregersen er owner på projektet): https://app.localizely.com/projects/3278b0a4-b1a5-4277-ba70-3159fb9dac9b/main/dashboard
Localizely konfiguration er definieret i `localizely-cli.json` filen i roden er projektet og kan justeres med Localizely branches osv.
For at opdatere strings.xml filen med seneste opdateringer fra Localizely, skal man via CLI i roden af projektet køre:
./localizely
Hvis macOS afviser, at køre CLI applikationen, kan du gå til System Preferences -> Security & Privacy og trykke "Open Anyway". CLI'en er et custom lavet Rust værktøj, der anvendes indtil Localizely kommer med deres eget officielle CLI (skulle være klar i løbet af august 2021). Det er altså ikke signeret korrekt, hvorfor macOS advarer imod programmet.
Alle delte strings ligger i `shared`-modulet, som er inkluderet i alle andre moduler. Siden alle moduler har deres egen R-fil, kan den delte strings R-fil importeres ind i filen ved at bruge:
import dk.nsp.mingraviditet.core.shared.R as sharedR
4. Signering
For at bygge release udgaver til Google Play / Firebase, skal de signeres med MinGraviditets Keystore (MinGraviditetKeystore20211203.jks).
For at bygge lokalt kræver det man har local.properties filen i roden af projektet, som indeholder keystore password, key alias og key password i formatet:
keystore_password=SuperSecretPassword private_alias=MyKeyAlias private_password=MyPrivatePasswordHere
Det er vigtigt at informationen i local.properties filen og selve keystore filen (.jks) IKKE ikke uploades til version control (De er pt. inkluderet i .gitignore).
For at kunne bygge skal disse filer være tilgængelige på maskinen der bliver bygget på:
local.properties
signing
├── MinGraviditetKeystore20211203.jks
└── min-graviditet-test-4807133482ad.json
Signeringsnøglen og koder hertil ligger pt hos Jan Buchholdt (jbu) fra Trifork.
5. Konfiguration
Beskrivelse af de nuværende konfigurationer kan findes på Installationsvejledningen https://www.nspop.dk/pages/viewpage.action?pageId=121373687#GravidiDK(Android)Installationsvejledning-Indledning
Udvikleren vælger selv en flavor og en buildtype i Android Studio, som derefter kan bygges og køres. Under udvikling bruges debug buildtypen, da denne outputter logs i logcat.
Alle bygge konfigurationer skal findes i projektets build.gradle.kts filer. Der findes en build.gradle.kts som deles af hele projektet og derunder findes der en build.gradle.kts for hvert modul af appen.
Hvert modul har deres eget ansvarsområde, så api/build.gradle.kts definerer f.eks. dependencies som det modul har brug for.
Library versioner er defineret i gradle/libs.version.toml . Hvis udvikleren ønsker at opdatere versionerne, bruges
./gradlew dependencyUpdates
Læs mere i projektets README.md
5.1. BuildLogic modulet
Projektet indeholder et vigtig gradle modul, som er med til at sætte alle android modulerne op på en ensartet måde; :build-logic.
Modulet er med til at sætte gradle versioning catalogs op og indeholder inkluderer en modul kalder :convention
:convention er en samling af gradle plugins, som kan bruges af appens moduler, f.eks. bruger feature modulerne det gradle plugin som hedder "mingraviditet.android.feature" og er defineret i filen AndroidFeatureConventionPlugin.kt
I :convention er der også defineret appens minimum version, targetSdk, flavors og generelle kotlin & compose opsætning.
6. Versionering
Appen versioneres efter almindelig major.minor.patch (version code). Projektet er opdelt i moduler, så styring af disse er samlet i root project build.gradle.kts i de to properties navngivet versionName og versionCode .
Version name er tiltænkt man manuelt opdatere når man laver changes som er passende på en af de tre niveauer.
Version code bliver automatisk forhøjet for hvert commit på den pågældende branch
7. Tags
Releases af appen markeres med Git tags på formen release/major.minor.patch_versioncode
Det er ikke tilladt at lave en release, uden der er et tilhørende tag på det commit man bygger fra (Dette er pt. ikke håndhævet ved manuelle byg, så dette er udviklerens eget ansvar at overholde).
Denne regel er indbygget i vores lanes i Fastlane, som et pre-check for at kunne køre de lanes som uploader appen - Heraf grunden til at Fastlane er anbefalt til distribution.
8. Distribution
8.1.1. Fastlane
Hele processen med at bygge og uploade til Firebase er blevet automatiseret med værktøjet Fastlane (https://fastlane.tools/).
Krav og installationsvejledninger kan findes på https://docs.fastlane.tools/getting-started/android/setup/#installing-fastlane
Ved at bruge kommandoen fastlane før man alle de mulige "lanes" frem, hvor man får nedenstående output.
Welcome to fastlane! Here's what your app is set up to do: +------------------------------------------------------------------------------------------------------------------------+ | Available lanes to run | +--------+-------------------------------+-------------------------------------------------------------------------------+ | Number | Lane Name | Description | +--------+-------------------------------+-------------------------------------------------------------------------------+ | 1 | android setGitTag | Add version tag to commit | | 2 | android bumpReleaseVersion | Bump, commit, tag and (optionally) push commit and tag | | 3 | android allUnitTests | | | 4 | android generateQaReports | Checks that git is in a correct state and we have a tag. Then generates Unit | | | | Test and Coverage reports | | 5 | android uploadForInternalTest | Upload Internal Test version to Firebase | | 6 | android uploadForGooglePlay | Build GooglePlay .aab and upload to Google Play (Takes the Service account | | | | json file path as a param) | | 0 | cancel | No selection, exit fastlane! | +--------+-------------------------------+-------------------------------------------------------------------------------+ Which number would you like to run?
8.1.1.1. Lanes
8.1.1.1.1. bumpReleaseVersion
Kører 4 operationer
- Opdaterer version code ud fra antallet af commits (På tværs af repositoriets branches) og skriver det ind i root projects
./build.gradle.kts - Commiter koden
- Opretter et release tag i git
- Giver udvikleren valget om at pushe commitet og det oprettede tag til remote repository
Efter denne operation er kørt (såfremt man valgte at sige ja til pkt. 4), vil det commit man står på være klar til lave en release.
8.1.1.1.2. Release lanes
Der kan releases til Firebase vha uploadForInternalTest og til GooglePlay ved hjælp af uploadForGooglePlay
8.2. Release til Google Play
For at kunne release kræves det at man har adgang til Sundhedsdatastyrelsens Google Play projekt.
Projektet er opsat i Google Play til at benytte sig af app bundles (.aab).
For at ensarte byg og upload af Google Play udgaven af appen, er der lavet en Fastlane lane uploadForGooglePlay som tager én parameter service_account_json_file (Som er den path hvor .json filen med info om den Google Cloud service account, som er tilknyttet Google Play projektet, befinder sig).
Denne lane bygger en .aab og uploader den til Google Play, så den kan findes under App bundle explorer , herfra følges standard release procedure i Google Play.