Publish app implementation #1201
Workflow file for this run
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
| # Conditionally publishes the current branch to GitHub Pages, and/or | |
| # updates docker image for pwa.kiwix.org | |
| # This workflow uses openzim/docker-publish-action@v6 | |
| # Documentation: https://github.com/openzim/docker-publish-action#readme | |
| name: Publish app implementation | |
| # Controls when the action will run. | |
| on: | |
| # Triggers the workflow on push to main | |
| push: | |
| branches: [ main ] | |
| # Triggers the workflow when a release is publsihed or updated | |
| release: | |
| types: [ published ] | |
| # Call this for testing from the REST API with '{"version":"{tag}"}' | |
| # 'https://api.github.com/repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches' | |
| workflow_dispatch: | |
| inputs: | |
| version: | |
| description: Specific version to build (overrides on-main and tag-pattern), e.g. 'v2.0.0' | |
| required: false | |
| default: '' | |
| target: | |
| description: 'Set the target to update: "ghpages" or "docker" (will update GitHub Pages by default)' | |
| type: choice | |
| required: false | |
| options: | |
| - ghpages | |
| - docker | |
| default: ghpages | |
| jobs: | |
| build-and-push: | |
| name: Deploy app to Docker and/or gh-pages | |
| if: | | |
| ! contains( ${{ github.ref_name }}, 'WikiMed') && ! contains( ${{ github.ref_name }}, 'Wikivoyage') | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Update app version number | |
| env: | |
| INPUT_VERSION: ${{ github.event.inputs.version }} | |
| run: | | |
| chmod +x ./scripts/rewrite_app_version_number.sh | |
| ./scripts/rewrite_app_version_number.sh | |
| - name: Build app with src bundle | |
| if: github.event.inputs.target == 'ghpages' || github.event_name == 'push' | |
| run: | | |
| npm ci | |
| npm run build-src | |
| - name: Build app with production bundle (src bundle also provided) | |
| if: github.event.inputs.target == 'docker' || github.event_name == 'release' | |
| run: | | |
| npm ci | |
| npm run build | |
| echo "After deployment the production app will be available at https://pwa.kiwix.org" | |
| - name: Build docker image and push | |
| if: github.event.inputs.target == 'docker' || github.event_name == 'release' | |
| uses: openzim/docker-publish-action@v8 | |
| with: | |
| image-name: kiwix/kiwix-pwa | |
| credentials: | | |
| GHCRIO_USERNAME=${{ secrets.GHCR_USERNAME }} | |
| GHCRIO_TOKEN=${{ secrets.GHCR_TOKEN }} | |
| tag-pattern: /^v?([0-9.]+)$/ | |
| latest-on-tag: true | |
| dockerfile: docker/dockerfile.pwa | |
| restrict-to: kiwix/kiwix-js-pwa | |
| registries: ghcr.io | |
| manual-tag: ${{ github.event.inputs.version }} | |
| - name: Restart live webapp | |
| if: github.event.inputs.target == 'docker' || github.event_name == 'release' | |
| uses: actions-hub/kubectl@master | |
| env: | |
| KUBE_CONFIG: ${{ secrets.KUBE_CONFIG }} | |
| with: | |
| args: rollout restart deployments pwa-deployment -n pwa | |
| # Publish to GitHub Pages if explicitly requested, or if releasing, or if pushing to main | |
| - name: Publish to GitHub Pages | |
| if: github.event.inputs.target == 'ghpages' || github.event_name == 'release' || github.event_name == 'push' | |
| run: | | |
| # Set up username and email | |
| echo "Publishing to GitHub pages..." | |
| git config user.name "GitHub Actions Bot" | |
| git config user.email "<>" | |
| # Patch gitignore so that files needed for the distribution are exposed | |
| chmod +x ./scripts/patch_gitignore.sh | |
| ./scripts/patch_gitignore.sh | |
| if [ ! -z "$(git status --porcelain)" ]; then | |
| git add . | |
| git commit -m "Set GitHub Pages release version" | |
| fi | |
| # Set gh-pages branch on origin to the currently checked-out branch | |
| git push origin HEAD:gh-pages --force | |
| echo "After deployment, the app will be available at https://kiwix.github.io/kiwix-js-pwa/" | |
| echo "The production deployment will be available at https://kiwix.github.io/kiwix-js-pwa/dist/" |