gitadmin/freeCodeCamp
1
0
Fork 0
mirror of https://github.com/freeCodeCamp/freeCodeCamp.git synced 2026-05-28 18:26:54 +00:00
Code Issues Packages Projects Releases Wiki Activity

fix(CD): update workflow for deployment

Browse Source
This commit is contained in:
Mrugesh Mohapatra
2025-03-13 14:28:42 +05:30
parent b432a6d2a0
commit 8fdb525895
1 changed files with 168 additions and 114 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.github/workflows/deploy-legacy.yml
+168 -114
View File
@@ -8,9 +8,9 @@ jobs:
name: Setup Jobs
runs-on: ubuntu-24.04
outputs:
site_tld: ${{ steps.setup.outputs.site_tld }} # Used to define URLs like api.freecodecamp.org, forum.freecodecamp.dev, etc.
environment: ${{ steps.setup.outputs.environment }} # Used to define the environment (prd, stg, etc.)
deployment_env: ${{ steps.setup.outputs.deployment_env }} # Used to define the deployment environment (production, staging, etc.)
site_tld: ${{ steps.setup.outputs.site_tld }} # org, dev
tgt_env_short: ${{ steps.setup.outputs.tgt_env_short }} # prd, stg
tgt_env_long: ${{ steps.setup.outputs.tgt_env_long }} # production, staging
steps:
- name: Setup
id: setup
@@ -18,28 +18,28 @@ jobs:
case "${{ github.ref }}" in
"refs/heads/prod-current")
echo "site_tld=org" >> $GITHUB_OUTPUT
echo "environment=prd" >> $GITHUB_OUTPUT
echo "deployment_env=production" >> $GITHUB_OUTPUT
echo "tgt_env_short=prd" >> $GITHUB_OUTPUT
echo "tgt_env_long=production" >> $GITHUB_OUTPUT
;;
*)
echo "site_tld=dev" >> $GITHUB_OUTPUT
echo "environment=stg" >> $GITHUB_OUTPUT
echo "deployment_env=staging" >> $GITHUB_OUTPUT
echo "tgt_env_short=stg" >> $GITHUB_OUTPUT
echo "tgt_env_long=staging" >> $GITHUB_OUTPUT
;;
esac
api:
name: Build & Deploy API (Legacy)
name: API (Legacy) - [${{ needs.setup-jobs.outputs.tgt_env_short }}]
needs: [setup-jobs]
runs-on: ubuntu-24.04
strategy:
matrix:
node-version: [20.x]
node-version: [20]
permissions:
deployments: write
contents: read
environment:
name: ${{ needs.setup-jobs.outputs.environment }}-api-legacy
name: ${{ needs.setup-jobs.outputs.tgt_env_short }}-api-legacy
env:
TS_USERNAME: ${{ secrets.TS_USERNAME }}
TS_MACHINE_NAME_PREFIX: ${{ secrets.TS_MACHINE_NAME_PREFIX }}
@@ -49,96 +49,121 @@ jobs:
with:
oauth-client-id: ${{ secrets.TS_OAUTH_CLIENT_ID }}
oauth-secret: ${{ secrets.TS_OAUTH_SECRET }}
hostname: gha-${{needs.setup-jobs.outputs.environment}}-api-legacy-ci-${{ github.run_id }}
hostname: gha-${{needs.setup-jobs.outputs.tgt_env_short}}-api-legacy-ci-${{ github.run_id }}
tags: tag:ci
version: latest
- name: Configure SSH
# This is a workaround to avoid the SSH warning about known hosts & strict host key checking.
# It's not a problem for us, because we're using Tailscale to connect.
- name: Configure SSH & Check Connection
run: |
mkdir -p ~/.ssh
mkdir -p ~/.ssh && \
echo "Host *
UserKnownHostsFile=/dev/null
StrictHostKeyChecking no" > ~/.ssh/config
StrictHostKeyChecking no" > ~/.ssh/config && \
chmod 644 ~/.ssh/config
if [ $? -ne 0 ]; then echo "::error::Failed to configure SSH"; exit 1; fi
- name: Check connection
run: |
for i in {1..3}; do
TS_MACHINE_NAME=${TS_MACHINE_NAME_PREFIX}-api-${i}
tailscale status | grep -q "$TS_MACHINE_NAME" || { echo "Error: Machine not found"; exit 1; }
tailscale status | grep -q "$TS_MACHINE_NAME" && \
ssh $TS_USERNAME@$TS_MACHINE_NAME "uptime"
if [ $? -ne 0 ]; then echo "::error::Failed to check connection"; exit 1; fi
done
# - name: Deploy API
# run: |
# export GIT_SOURCE_BRANCH=prod-${{ needs.setup-jobs.outputs.environment }}
# ssh $TS_USERNAME@$TS_MACHINE_NAME /bin/bash << EOF
# set -e
# cd /home/${TS_USERNAME}/freeCodeCamp || { echo "::error::Failed to change directory"; exit 1; }
- name: Deploy API
run: |
export GIT_SOURCE_BRANCH=prod-${{ needs.setup-jobs.outputs.tgt_env_long }}
for i in {1..3}; do
TS_MACHINE_NAME=${TS_MACHINE_NAME_PREFIX}-api-${i}
ssh $TS_USERNAME@$TS_MACHINE_NAME /bin/bash << EOF
set -e
echo "Deploying API (Legacy) to $TS_MACHINE_NAME"
# pm2 stop all
cd /home/$TS_USERNAME/freeCodeCamp
if [ $? -ne 0 ]; then echo "::error::Failed to change to working directory"; exit 1; fi
# git status || { echo "::error::Failed to check git status"; exit 1; }
# git clean -f || { echo "::error::Failed to clean git"; exit 1; }
# git fetch --all --prune || { echo "::error::Failed to fetch git"; exit 1; }
# git checkout -f $GIT_SOURCE_BRANCH || { echo "::error::Failed to checkout branch"; exit 1; }
# Environment setup
export NVM_DIR=\$HOME/.nvm && [ -s "\$NVM_DIR/nvm.sh" ] && source "\$NVM_DIR/nvm.sh" && \
nvm ls | grep 'default' && \
echo "Node.js version:" && node --version
if [ $? -ne 0 ]; then echo "::error::Failed during environment setup"; exit 1; fi
# git reset --hard origin/${GIT_SOURCE_BRANCH} || { echo "::error::Failed to reset git"; exit 1; }
# git status || { echo "::error::Failed to check git status"; exit 1; }
# Stop all PM2 services
pm2 stop all
if [ $? -ne 0 ]; then echo "::error::Failed to stop PM2 services"; exit 1; fi
# npm i -g pnpm@9 || { echo "::error::Failed to install pnpm"; exit 1; }
# Git operations
git status && \
git clean -f && \
git fetch --all --prune && \
git checkout -f $GIT_SOURCE_BRANCH && \
git reset --hard origin/$GIT_SOURCE_BRANCH && \
git status
if [ $? -ne 0 ]; then echo "::error::Failed during git operations"; exit 1; fi
# pnpm clean:packages || { echo "::error::Failed to clean packages"; exit 1; }
# pnpm clean:server || { echo "::error::Failed to clean server"; exit 1; }
# pnpm install || { echo "::error::Failed to install dependencies"; exit 1; }
# pnpm prebuild || { echo "::error::Failed prebuild"; exit 1; }
# pnpm build:curriculum || { echo "::error::Failed to build curriculum"; exit 1; }
# pnpm build:server || { echo "::error::Failed to build server"; exit 1; }
# Build
npm i -g pnpm@9 && \
pnpm clean:packages && \
pnpm clean:server && \
pnpm install && \
pnpm prebuild && \
pnpm build:curriculum && \
pnpm build:server
if [ $? -ne 0 ]; then echo "::error::Failed during build process"; exit 1; fi
# pnpm reload:server || { echo "::error::Failed to reload server"; exit 1; }
# pm2 ls || { echo "::error::Failed to list PM2 processes"; exit 1; }
# pm2 save || { echo "::error::Failed to save PM2 processes"; exit 1; }
# EOF
# Server reload
pnpm reload:server && \
pm2 ls && \
pm2 save
if [ $? -ne 0 ]; then echo "::error::Failed during server reload"; exit 1; fi
EOF
done
client:
name: Build Client
name: Clients - [${{ needs.setup-jobs.outputs.tgt_env_short }}] [${{ matrix.lang-name-short }}]
needs: [setup-jobs, api]
runs-on: ubuntu-24.04
strategy:
matrix:
node-version: [20.x]
lang:
node-version: [20]
lang-name-full:
- english
- chinese
- espanol
- chinese-traditional
- italian
- portuguese
- ukrainian
- japanese
- german
- swahili
include:
- lang: english
short-name: eng
- lang: chinese
short-name: chn
- lang: espanol
short-name: esp
- lang-name-full: english
lang-name-short: eng
- lang-name-full: chinese
lang-name-short: chn
- lang-name-full: espanol
lang-name-short: esp
- lang-name-full: chinese-traditional
lang-name-short: cnt
- lang-name-full: italian
lang-name-short: ita
- lang-name-full: portuguese
lang-name-short: por
- lang-name-full: ukrainian
lang-name-short: ukr
- lang-name-full: japanese
lang-name-short: jpn
- lang-name-full: german
lang-name-short: ger
- lang-name-full: swahili
lang-name-short: swa
permissions:
deployments: write
contents: read
environment:
name: ${{ needs.setup-jobs.outputs.environment }}-clients
name: ${{ needs.setup-jobs.outputs.tgt_env_short }}-clients
env:
API_LOCATION: 'https://api.freecodecamp.${{ needs.setup-jobs.outputs.site_tld }}'
ALGOLIA_APIKEY: ${{ secrets.ALGOLIA_APIKEY }}
ALGOLIA_APP_ID: ${{ secrets.ALGOLIA_APP_ID }}
GROWTHBOOK_URI: ${{ secrets.GROWTHBOOK_URI }}
FORUM_LOCATION: 'https://forum.freecodecamp.org'
PATREON_CLIENT_ID: ${{ secrets.PATREON_CLIENT_ID }}
PAYPAL_CLIENT_ID: ${{ secrets.PAYPAL_CLIENT_ID }}
STRIPE_PUBLIC_KEY: ${{ secrets.STRIPE_PUBLIC_KEY }}
SHOW_UPCOMING_CHANGES: ${{ vars.SHOW_UPCOMING_CHANGES }}
# The below is used in ecosystem.config.js file for the API -- to be removed later
DEPLOYMENT_ENV: ${{ needs.setup-jobs.outputs.deployment_env }}
# The above is used in ecosystem.config.js file for the API -- to be removed later
TS_USERNAME: ${{ secrets.TS_USERNAME }}
TS_MACHINE_NAME_PREFIX: ${{ secrets.TS_MACHINE_NAME_PREFIX }}
@@ -159,86 +184,115 @@ jobs:
node-version: ${{ matrix.node-version }}
cache: pnpm
- name: Prepare language specific ENV
- name: Language specific ENV - [${{ matrix.lang-name-full }}]
run: |
if [ "${{ matrix.lang }}" = "english" ]; then
if [ "${{ matrix.lang-name-full }}" = "english" ]; then
echo "HOME_LOCATION=https://www.freecodecamp.${{ needs.setup-jobs.outputs.site_tld }}" >> $GITHUB_ENV
echo "NEWS_LOCATION=https://www.freecodecamp.${{ needs.setup-jobs.outputs.site_tld }}/news" >> $GITHUB_ENV
else
echo "HOME_LOCATION=https://www.freecodecamp.${{ needs.setup-jobs.outputs.site_tld }}/${{ matrix.lang }}" >> $GITHUB_ENV
echo "NEWS_LOCATION=https://www.freecodecamp.${{ needs.setup-jobs.outputs.site_tld }}/${{ matrix.lang }}/news" >> $GITHUB_ENV
echo "HOME_LOCATION=https://www.freecodecamp.${{ needs.setup-jobs.outputs.site_tld }}/${{ matrix.lang-name-full }}" >> $GITHUB_ENV
echo "NEWS_LOCATION=https://www.freecodecamp.${{ needs.setup-jobs.outputs.site_tld }}/${{ matrix.lang-name-full }}/news" >> $GITHUB_ENV
fi
echo "CLIENT_LOCALE=${{ matrix.lang }}" >> $GITHUB_ENV
echo "CURRICULUM_LOCALE=${{ matrix.lang }}" >> $GITHUB_ENV
echo "CLIENT_LOCALE=${{ matrix.lang-name-full }}" >> $GITHUB_ENV
echo "CURRICULUM_LOCALE=${{ matrix.lang-name-full }}" >> $GITHUB_ENV
- name: Install and Build
env:
API_LOCATION: 'https://api.freecodecamp.${{ needs.setup-jobs.outputs.site_tld }}'
ALGOLIA_API_KEY: ${{ secrets.ALGOLIA_API_KEY }}
ALGOLIA_APP_ID: ${{ secrets.ALGOLIA_APP_ID }}
GROWTHBOOK_URI: ${{ secrets.GROWTHBOOK_URI }}
FORUM_LOCATION: 'https://forum.freecodecamp.org'
PATREON_CLIENT_ID: ${{ secrets.PATREON_CLIENT_ID }}
PAYPAL_CLIENT_ID: ${{ secrets.PAYPAL_CLIENT_ID }}
STRIPE_PUBLIC_KEY: ${{ secrets.STRIPE_PUBLIC_KEY }}
SHOW_UPCOMING_CHANGES: ${{ vars.SHOW_UPCOMING_CHANGES }}
FREECODECAMP_NODE_ENV: production
# The below is used in ecosystem.config.js file for the API -- to be removed later
DEPLOYMENT_ENV: ${{ needs.setup-jobs.outputs.tgt_env_long }}
# The above is used in ecosystem.config.js file for the API -- to be removed later
run: |
# pnpm install
# pnpm run build
mkdir -p client/public
touch client/public/test-${{ matrix.short-name }}.txt
pnpm install
pnpm run build
# We tar them for performance reasons - uploading a lot of files is slow.
- name: Tar Files
run: tar -czf client-${{ matrix.short-name }}.tar client/public
run: tar -czf client-${{ matrix.lang-name-short }}.tar client/public
- name: Setup and connect to Tailscale network
uses: tailscale/github-action@v3
with:
oauth-client-id: ${{ secrets.TS_OAUTH_CLIENT_ID }}
oauth-secret: ${{ secrets.TS_OAUTH_SECRET }}
hostname: gha-${{needs.setup-jobs.outputs.environment}}-clients-ci-${{ github.run_id }}
hostname: gha-${{needs.setup-jobs.outputs.tgt_env_short}}-clients-ci-${{ github.run_id }}
tags: tag:ci
version: latest
- name: Configure SSH
# This is a workaround to avoid the SSH warning about known hosts & strict host key checking.
# It's not a problem for us, because we're using Tailscale to connect.
- name: Configure SSH & Check Connection
run: |
mkdir -p ~/.ssh
mkdir -p ~/.ssh && \
echo "Host *
UserKnownHostsFile=/dev/null
StrictHostKeyChecking no" > ~/.ssh/config
StrictHostKeyChecking no" > ~/.ssh/config && \
chmod 644 ~/.ssh/config
if [ $? -ne 0 ]; then echo "::error::Failed to configure SSH"; exit 1; fi
- name: Check connection
run: |
for i in {0..1}; do
TS_MACHINE_NAME=${TS_MACHINE_NAME_PREFIX}-${{ matrix.short-name }}-${i}
tailscale status | grep -q "$TS_MACHINE_NAME" || { echo "Error: Machine not found"; exit 1; }
TS_MACHINE_NAME=${TS_MACHINE_NAME_PREFIX}-${{ matrix.lang-name-short }}-${i}
tailscale status | grep -q "$TS_MACHINE_NAME" && \
ssh $TS_USERNAME@$TS_MACHINE_NAME "uptime"
if [ $? -ne 0 ]; then echo "::error::Failed to check connection"; exit 1; fi
done
# - name: Upload and Deploy
# run: |
# for i in {0..1}; do
- name: Upload and Deploy
run: |
for i in {0..1}; do
# TS_MACHINE_NAME=${TS_MACHINE_NAME_PREFIX}-${{ matrix.short-name }}-${i}
# scp client-${{ matrix.short-name }}.tar $TS_USERNAME@$TS_MACHINE_NAME:/tmp/${{ github.run_id }}-client-${{ matrix.short-name }}.tar || { echo "::error::Failed to upload client archive"; exit 1; }
TS_MACHINE_NAME=${TS_MACHINE_NAME_PREFIX}-${{ matrix.lang-name-short }}-${i}
CURRENT_DATE=$(date +%Y%m%d)
CLIENT_SRC=client-${{ matrix.lang-name-short }}.tar
CLIENT_DST=/tmp/client-${{ matrix.lang-name-short }}-${CURRENT_DATE}-${{ github.run_id }}.tar
CLIENT_BINARIES=${{needs.setup-jobs.outputs.tgt_env_short}}-release-$CURRENT_DATE-${{ github.run_id }}
# ssh $TS_USERNAME@$TS_MACHINE_NAME /bin/bash << EOF
# set -e
# Upload client archive
scp $CLIENT_SRC $TS_USERNAME@$TS_MACHINE_NAME:$CLIENT_DST
if [ $? -ne 0 ]; then echo "::error::Failed to upload client archive"; exit 1; fi
# export CURRENT_DATE=$(date +%Y%m%d)
# export CLIENT_BINARIES=gha-${{needs.setup-jobs.outputs.environment}}-release-${CURRENT_DATE}-${{ github.run_id }}
ssh $TS_USERNAME@$TS_MACHINE_NAME /bin/bash << EOF
set -e
# mkdir -p /home/${TS_USERNAME}/client/releases/${CLIENT_BINARIES} || { echo "::error::Failed to create client release directory"; exit 1; }
# tar -xzf /tmp/${{ github.run_id }}-client-${{ matrix.short-name }}.tar -C /home/${TS_USERNAME}/client/releases/${CLIENT_BINARIES} || { echo "::error::Failed to extract client archive"; exit 1; }
# rm /tmp/${{ github.run_id }}-client-${{ matrix.short-name }}.tar
# Extract client archive
mkdir -p /home/$TS_USERNAME/client/releases/$CLIENT_BINARIES && \
tar -xzf $CLIENT_DST -C /home/$TS_USERNAME/client/releases/$CLIENT_BINARIES --strip-components=2 && \
rm $CLIENT_DST && \
du -sh /home/$TS_USERNAME/client/releases/$CLIENT_BINARIES
if [ $? -ne 0 ]; then echo "::error::Failed to extract client archive"; exit 1; fi
# cd /home/${TS_USERNAME}/client || { echo "::error::Failed to change to client directory"; exit 1; }
# npm install -g serve@13 || { echo "::error::Failed to install serve"; exit 1; }
cd /home/$TS_USERNAME/client
if [ $? -ne 0 ]; then echo "::error::Failed to change to working directory"; exit 1; fi
# rm -f client-start-primary.sh
# echo "serve -c ../../serve.json releases/${CLIENT_BINARIES} -p 50505" >> client-start-primary.sh || { echo "::error::Failed to create primary script"; exit 1; }
# chmod +x client-start-primary.sh || { echo "::error::Failed to make primary script executable"; exit 1; }
# pm2 delete client-primary || true
# pm2 start ./client-start-primary.sh --name client-primary || { echo "::error::Failed to start primary client"; exit 1; }
# Environment setup
export NVM_DIR=\$HOME/.nvm && [ -s "\$NVM_DIR/nvm.sh" ] && source "\$NVM_DIR/nvm.sh" && \
nvm ls | grep 'default' && \
echo "Node.js version:" && node --version
if [ $? -ne 0 ]; then echo "::error::Failed during environment setup"; exit 1; fi
# rm -f client-start-secondary.sh
# echo "serve -c ../../serve.json releases/${CLIENT_BINARIES} -p 52525" >> client-start-secondary.sh || { echo "::error::Failed to create secondary script"; exit 1; }
# chmod +x client-start-secondary.sh || { echo "::error::Failed to make secondary script executable"; exit 1; }
# pm2 delete client-secondary || true
# pm2 start ./client-start-secondary.sh --name client-secondary || { echo "::error::Failed to start secondary client"; exit 1; }
# EOF
npm install -g serve@13
if [ $? -ne 0 ]; then echo "::error::Failed to install serve"; exit 1; fi
# done
# Primary client setup
rm -f client-start-primary.sh && \
echo "serve -c ../../serve.json releases/$CLIENT_BINARIES -p 50505" >> client-start-primary.sh && \
chmod +x client-start-primary.sh && \
pm2 delete client-primary || true && \
pm2 start ./client-start-primary.sh --name client-primary
if [ $? -ne 0 ]; then echo "::error::Failed to setup primary client"; exit 1; fi
# Secondary client setup
rm -f client-start-secondary.sh && \
echo "serve -c ../../serve.json releases/$CLIENT_BINARIES -p 52525" >> client-start-secondary.sh && \
chmod +x client-start-secondary.sh && \
pm2 delete client-secondary || true && \
pm2 start ./client-start-secondary.sh --name client-secondary
if [ $? -ne 0 ]; then echo "::error::Failed to setup secondary client"; exit 1; fi
EOF
done