Skip to content

Fix meta-links

Fix meta-links #4258

Workflow file for this run

on:
push:
branches:
- '**'
jobs:
build_docs:
name: Build the dev documentation site
runs-on: ubuntu-latest
permissions:
contents: 'read'
id-token: 'write'
env:
HUGO_VERSION: 0.143.1
GCLOUD_VERSION: 458.0.1-linux-x86_64
BUCKET: docs-dev-learn-redis-com
PROJECT_ID: redis-learning-staging
SERVICE_ACCOUNT: 'github-cicd-sa-terraform@redis-learning-staging.iam.gserviceaccount.com'
WORKLOAD_IDENTITY_PROVIDER: 'projects/882631252118/locations/global/workloadIdentityPools/github-pool/providers/redis-learn'
steps:
- name: Start
run: echo "The name of the branch is ${{ github.ref }} on ${{ github.repository }}"
- name: Install Hugo
run: |
wget -O ${{ runner.temp }}/hugo.deb https://github.com/gohugoio/hugo/releases/download/v${HUGO_VERSION}/hugo_extended_${HUGO_VERSION}_linux-amd64.deb \
&& sudo dpkg -i ${{ runner.temp }}/hugo.deb
- name: Check the branch out
uses: actions/checkout@v4
- name: 'Google auth'
uses: 'google-github-actions/auth@v2'
with:
project_id: '${{ env.PROJECT_ID }}'
service_account: '${{ env.SERVICE_ACCOUNT }}'
workload_identity_provider: '${{ env.WORKLOAD_IDENTITY_PROVIDER }}'
- name: 'Set up Cloud SDK'
uses: 'google-github-actions/setup-gcloud@v1'
with:
project_id: '${{ env.PROJECT_ID }}'
- name: List repository files
run: ls ${{ github.workspace }}
- name: Validate the branch name before using it
run: |
if [[ "${{ github.ref_name }}" =~ ^[a-zA-Z0-9_.-]+$ ]]
then
echo "The branch name ${{ github.ref_name }} is valid."
else
echo "ERROR: Invalid branch name ${{ github.ref_name }}!"
exit 1
fi
- name: Install the Google Cloud CLI
run: |
wget -O ${{ github.workspace }}/google-cloud-cli.tar.gz "https://dl.google.com/dl/cloudsdk/channels/rapid/downloads/google-cloud-cli-$GCLOUD_VERSION.tar.gz" \
&& tar -xvf google-cloud-cli.tar.gz -C ${{ github.workspace }}\
&& ${{ github.workspace }}/google-cloud-sdk/install.sh --quiet
- name: Install dependencies
run: make deps
- name: Build out all versions
run: |
set -x
ls content/operate/kubernetes/
kubernetes_versions=($(find content/operate/kubernetes/ -maxdepth 1 -type d -regex ".*[0-9-]" | awk -F/ '{print $NF}'))
rs_versions=($(find content/operate/rs/ -maxdepth 1 -type d -regex ".*[0-9-]" | awk -F/ '{print $NF}'))
# build latest
for version in "${kubernetes_versions[@]}"; do
rm -r "content/operate/kubernetes/${version}"
done
for version in "${rs_versions[@]}"; do
rm -r "content/operate/rs/${version}"
done
hugo -d public-latest
git checkout .
# build all versions
for version in "${kubernetes_versions[@]}"; do
ls content/operate/kubernetes/
# for each version, remove all other versions before building
versions_to_remove=($(echo "${kubernetes_versions[@]}" "${version}" | tr ' ' '\n' | sort | uniq -u))
for version_to_remove in "${versions_to_remove[@]}"; do
rm -r "content/operate/kubernetes/${version_to_remove}"
done
ls content/operate/kubernetes/
cp -r "content/operate/kubernetes/${version}"/* content/operate/kubernetes/
rm -r "content/operate/kubernetes/${version}"
sed -i 's/id="versionSelectorKubernetesValue" class="version-selector-control">latest/id="versionSelectorKubernetesValue" class="version-selector-control">v'"${version}"'/' layouts/partials/docs-nav.html
sed -i 's/linkTitle: '"${version}"'/linkTitle: Redis for Kubernetes/' content/operate/kubernetes/_index.md
# inject replace command in meta-links to make sure editURL and issuesURL point to right version
sed -i "11i \{\{ \$gh_file = replaceRE \`\^operate\/kubernetes\/\` \"operate\/kubernetes\/$version\/\" \$gh_file }}" layouts/partials/meta-links.html
hugo -d "kubernetes-${version}"
git checkout .
done
for version in "${rs_versions[@]}"; do
ls content/operate/rs/
# for each version, remove all other versions before building
versions_to_remove=($(echo "${rs_versions[@]}" "${version}" | tr ' ' '\n' | sort | uniq -u))
for version_to_remove in "${versions_to_remove[@]}"; do
rm -r "content/operate/rs/${version_to_remove}"
done
ls content/operate/rs/
cp -r "content/operate/rs/${version}"/* content/operate/rs/
rm -r "content/operate/rs/${version}"
sed -i 's/id="versionSelectorRsValue" class="version-selector-control">latest/id="versionSelectorRsValue" class="version-selector-control">v'"${version}"'/' layouts/partials/docs-nav.html
sed -i 's/linkTitle: '"${version}"'/linkTitle: Redis Software/' content/operate/rs/_index.md
# inject replace command in meta-links to make sure editURL and issuesURL point to right version
sed -i "11i \{\{ \$gh_file = replaceRE \`\^operate\/rs\/\` \"operate\/rs\/$version\/\" \$gh_file }}" layouts/partials/meta-links.html
hugo -d "rs-${version}"
git checkout .
done
- name: Sync the branch to the bucket
run: |
if [[ "${{ github.ref_name }}" == "main" ]]
then
bucket_path=staging/dev
elif [[ "${{ github.ref_name }}" == "latest" ]]
then
bucket_path=${{ github.ref_name }}
elif [[ "${{ endsWith(github.ref_name, '-build') }}" == "true" ]]
then
bucket_path=`echo "version/${{ github.ref_name }}" | sed 's/-build$//'`
else
bucket_path=staging/${{ github.ref_name }}
fi \
&& ./google-cloud-sdk/bin/gsutil -m rsync -r -c -j html -d ${{ github.workspace }}/public-latest gs://$BUCKET/latest/
versioned_builds=($(find . -type d -regex ".*[0-9-]" -maxdepth 1 | sed -E 's/^.\///'))
for versioned_build in "${versioned_builds[@]}"; do
product=$(grep -Eo '[a-zA-Z]+' <<< $versioned_build)
gsutil -m rsync -r -c -j html -d "${{ github.workspace }}/${versioned_build}/operate/${product}" "gs://docs-dev-learn-redis-com/${versioned_build}/operate/${product}"
done
- name: End
run: echo "This job's status is ${{ job.status }}."