🇨🇿 Česká verze README

GitHub action used to build and upload your Docker images to Tour de Cloud.

Warning

The action is guaranteed to fail if the team has not yet paid the starting fee for the competition.

❓ How to use

There are 2 main steps to make sure your application builds and uploads successfully:

1. Make sure your project has a .github/workflows/deploy.yml file with the following(or similar) content:

   name: Build and push Web App to TdA
   
   on:
     push:
       branches:
         - main
   
   permissions:
     contents: read
   
   jobs:
     build:
       runs-on: ubuntu-latest
       steps:
         - name: Check Out Repo
           uses: actions/checkout@v4
   
         - name: Upload to TdA
           uses: Student-Cyber-Games/upload-app@tda-26
           with:
             tdc_token: ${{ secrets.TDC_TOKEN }}

   This will trigger a build and upload action on every push to the main branch. You can change this to any branch you want.

Important

Make sure to set the TDC_TOKEN secret in your repository settings. How to create?

2. Make sure your project has a tourdeapp.yaml file in the root directory of your repository. This file is used to configure the build process and specify the details of your web app. Here is an example configuration:

   # $schema: https://portalbush.tourde.cloud/static/schema.json
   # ... (the rest of your configuration - see guides to create in TdC documentation)
   build:
     - name: frontend
       context: .
       dockerfile: ./apps/web/Dockerfile
     - name: backend
       context: .
       dockerfile: ./apps/server/Dockerfile
   

   This example specifies 2 docker images to be built: frontend and backend(will differ in your app). You can adjust the context and dockerfile paths according to your project structure.

Tip

The tourdeapp.yaml file supports build-time Docker args and bash environment substitution. You can specify them under the args section for each build target. For example:

build:
 - name: frontend
   context: .
   dockerfile: ./apps/web/Dockerfile
   args:
     REACT_APP_API_URL: "https://api.example.com"
     REACT_APP_API_KEY: {{API_KEY_ENV_VAR}}

Note that, in order to have the API_KEY_ENV_VAR substituted correctly, you need to put it in the env section of the GitHub action, like so:

env:
  API_KEY_ENV_VAR: ${{ secrets.API_KEY_ENV_VAR }}