Mercure-Hub: 4. GitHub Actions
This documentation is part of the GitHub Actions & GitLab CI guide. You can view the complete guide here: Launch a real Mercure Hub service from your GitHub Actions or GitLab CI pipeline, run your tests against it, and automatically tear it down.
👋 Welcome to the Stackhero documentation!
Stackhero offers a fully managed Mercure-Hub cloud service designed to simplify and ensure reliable real-time data delivery. You benefit from:
- Unlimited requests and message sizes for total flexibility.
- A custom domain with integrated HTTPS security (for example, https://real-time.your-company.com).
- One-click updates to keep your hub up to date effortlessly.
- High performance and enhanced security on a private, dedicated infrastructure.
- Multiple available regions: 🇪🇺 Europe and 🇺🇸 USA for low-latency delivery.
Get started quickly: it only takes 5 minutes to launch your Mercure-Hub cloud hosting environment and start sending real-time updates to your applications.
To get started, save the following as .github/workflows/ci.yml. From now on, every push and pull request will run tests against a real Mercure Hub instance.
name: CI with Mercure Hub
on: [push, pull_request]
jobs:
test:
runs-on: ubuntu-latest
env:
STACKHERO_TOKEN: ${{ secrets.STACKHERO_TOKEN }}
STACK_NAME: ci-mercure-hub-${{ github.run_id }}-${{ github.run_attempt }}
INSTANCE: "20G" # Change this as needed (see step 3)
REGION: europe
steps:
- uses: actions/checkout@v4
- name: Install the Stackhero CLI and the client
run: |
curl -fsSL https://www.stackhero.io/install.sh | sh
apt-get update && apt-get install -y --no-install-recommends jq curl
- name: Create the Mercure Hub service
run: |
set -euo pipefail
STACK_ID=$(stackhero --format=script stack-create --name="$STACK_NAME")
echo "STACK_ID=$STACK_ID" >> "$GITHUB_ENV"
SERVICE_ID=$(stackhero --format=script service-add \
--stack="$STACK_ID" \
--service-store="mercure-hub" \
--instance="$INSTANCE" \
--region="$REGION")
echo "SERVICE_ID=$SERVICE_ID" >> "$GITHUB_ENV"
stackhero service-wait-for --service="$SERVICE_ID"
- name: Run tests against Mercure Hub
run: |
set -euo pipefail
config=$(stackhero service-configuration-get --service="$SERVICE_ID" --format=json)
host=$(echo "$config" | jq -r '.configuration.domain')
# Request the hub endpoint and check it answers.
curl -fsS -o /dev/null -w "%{http_code}" "https://$host/.well-known/mercure?topic=test" | grep -qE "^(200|400|401)$"
echo "✅ Mercure Hub is reachable from CI."
# You can run your own test suite here using the credentials above ...
- name: Tear down (always, even on failure)
if: always()
run: |
if [ -n "${SERVICE_ID:-}" ]; then
stackhero service-delete --service="$SERVICE_ID" --confirm
stackhero service-wait-for --service="$SERVICE_ID"
fi
if [ -n "${STACK_ID:-}" ]; then
stackhero stack-delete --stack="$STACK_ID" --confirm
fi
The teardown step uses if: always() to ensure it runs in all cases, making sure your Mercure Hub instance is deleted and you are not billed for unused resources.