-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #302 from dhis2/docs
docs: [ANDROAPP-6451] Init mobile UI documentation
- Loading branch information
Showing
69 changed files
with
732 additions
and
1,004 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,20 +1,22 @@ | ||
| # This is a basic workflow to help you get started with Actions | ||
|
|
||
| name: Continuous deployment | ||
|
|
||
| # Controls when the workflow will run | ||
| env: | ||
| main_project_module: android | ||
|
|
||
| on: | ||
| push: | ||
| branches: | ||
| - develop | ||
| - develop # Automatically generates snapshot versions | ||
|
|
||
| # Allows you to run this workflow manually from the Actions tab | ||
| workflow_dispatch: | ||
| workflow_dispatch: ## manually generates release versions | ||
| inputs: | ||
| release_version: | ||
| description: 'Please, enter the release version' | ||
| required: true | ||
| type: string | ||
|
|
||
| # A workflow run is made up of one or more jobs that can run sequentially or in parallel | ||
| jobs: | ||
| # This workflow contains a single job called "build" | ||
| publish: | ||
| publish-maven: | ||
| # The type of runner that the job will run on | ||
| runs-on: ubuntu-latest | ||
|
|
||
|
|
@@ -41,3 +43,38 @@ jobs: | |
| OSSRH_PASSWORD: ${{ secrets.SONATYPE_OSSRH_PASSWORD }} | ||
| SIGNING_PRIVATE_KEY: ${{ secrets.PGP_PRIVATE_KEY }} | ||
| SIGNING_PASSWORD: ${{ secrets.PGP_PASSPHRASE }} | ||
|
|
||
| publish_github: | ||
| runs-on: ubuntu-latest | ||
| if: ${{ (inputs.release_version) && (inputs.release_version != '') }} | ||
| steps: | ||
| - name: Checkout | ||
| uses: actions/checkout@v4 | ||
|
|
||
| - name: Set up JDK 17 | ||
| uses: actions/setup-java@v4 | ||
| with: | ||
| java-version: 17 | ||
| distribution: temurin | ||
| cache: 'gradle' | ||
|
|
||
| - name: Change wrapper permissions | ||
| run: chmod +x ./gradlew | ||
|
|
||
| - name: Build Android (APK) - ${{ env.main_project_module }} module | ||
| run: ./gradlew assembleDebug | ||
|
|
||
| - name: Rename APK | ||
| run: | | ||
| mv ${{ env.main_project_module }}/build/outputs/apk/debug/android-debug.apk ${{ env.main_project_module }}/build/outputs/apk/debug/ui-components-android-${{ inputs.release_version }}.apk | ||
| - name: Github Release | ||
| uses: ncipollo/[email protected] | ||
| with: | ||
| allowUpdates: true | ||
| draft: true | ||
| generateReleaseNotes: true | ||
| name: "Release notes - DHIS2 Design system: ${{ inputs.release_version }}" | ||
| tag: ${{ inputs.release_version }} | ||
| artifacts: ${{ env.main_project_module }}/build/outputs/apk/debug/ui-components-android-${{ inputs.release_version }}.apk | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,57 @@ | ||
| name: Deploy API docs | ||
|
|
||
| on: | ||
| push: | ||
| branches: | ||
| - main | ||
| - docs | ||
|
|
||
| workflow_dispatch: | ||
|
|
||
| permissions: | ||
| contents: read | ||
| pages: write | ||
| id-token: write | ||
|
|
||
| concurrency: | ||
| group: "pages" | ||
| cancel-in-progress: false | ||
|
|
||
| jobs: | ||
| build: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Checkout | ||
| uses: actions/checkout@v4 | ||
| - name: Setup Pages | ||
| uses: actions/configure-pages@v5 | ||
| - name: Set up JDK 17 | ||
| uses: actions/setup-java@v4 | ||
| with: | ||
| java-version: 17 | ||
| distribution: temurin | ||
| cache: 'gradle' | ||
| - name: Change wrapper permission | ||
| run: chmod +x ./gradlew | ||
|
|
||
| - name: Build Java docs | ||
| run: ./gradlew :designsystem:dokkaHtml -PremoveSnapshotSuffix | ||
|
|
||
| - name: Organize pages structure | ||
| run: | | ||
| mkdir _site && mkdir _site/api | ||
| cp -r designsystem/build/dokka/html/* _site/api | ||
| - name: Upload artifact | ||
| uses: actions/upload-pages-artifact@v3 | ||
|
|
||
| deploy: | ||
| environment: | ||
| name: github-pages | ||
| url: ${{ steps.deployment.outputs.page_url }} | ||
| runs-on: ubuntu-latest | ||
| needs: build | ||
| steps: | ||
| - name: Deploy to GitHub Pages | ||
| id: deployment | ||
| uses: actions/deploy-pages@v4 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.