Helios User Guide

Overview

Helios is a deployment management tool that simplifies the process of deploying pull requests and branches to test environments. This guide walks you through the basic deployment workflow.

Prerequisites

  • GitHub account with access to the repository

  • Proper permissions to deploy

  • Available test environment

Deployment Workflow

1. Repository Selection

Select the repository you want to deploy from the main dashboard.

Repository selection screen

2. Authentication

Log in with your GitHub credentials.

Login with GitHub
GitHub authentication

3. Pull Request Selection

Choose the pull request or branch you want to deploy.

Pull request details screen

4. Deployment Initiation

Click the deploy button to start the deployment process.

Deploy button and options

The deployment enters a pending state while resources are being allocated.

Deployment pending status

The deployment moves to the in-progress state during active deployment.

Deployment progress status

5. Unlock the test environment once you finish testing.

Unlock test environment

Troubleshooting

Manual Deployment Fallback

⚠️ Warning: Manual workflow deployment should be used only as a last resort as it may conflict with Helios environment locking.

If Helios deployment fails, you can use the GitHub workflow as a fallback:

Access the workflow at:

https://github.com/ls1intum/Artemis/actions/workflows/testserver-deployment.yml

GitHub deployment workflow

Required Inputs

  • Use workflow from: Select your target branch

  • Which branch to deploy: Again, select your target branch

  • Which environment to deploy: Use format artemis-test7.artemis.cit.tum.de

  • Username (optional): Your GitHub username

Support

For assistance: