undeploy #16
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
# THIS FILE IS PART OF THE CYLC WORKFLOW ENGINE. | |
# Copyright (C) NIWA & British Crown (Met Office) & Contributors. | |
# | |
# This program is free software: you can redistribute it and/or modify | |
# it under the terms of the GNU General Public License as published by | |
# the Free Software Foundation, either version 3 of the License, or | |
# (at your option) any later version. | |
# | |
# This program is distributed in the hope that it will be useful, | |
# but WITHOUT ANY WARRANTY; without even the implied warranty of | |
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
# GNU General Public License for more details. | |
# | |
# You should have received a copy of the GNU General Public License | |
# along with this program. If not, see <http://www.gnu.org/licenses/>. | |
# Remove a deployed version of the documentation. | |
# Note: All changes made to the gh-pages branch are non-destructive | |
# (i.e. no force pushing) so all changes can be undone. | |
name: undeploy | |
on: | |
workflow_dispatch: | |
inputs: | |
tag: | |
description: 'Tag present on both cylc-flow and cylc-doc' | |
required: true | |
concurrency: | |
group: ${{ github.workflow }}-${{ github.ref }} | |
jobs: | |
undeploy: | |
runs-on: ubuntu-latest | |
timeout-minutes: 10 | |
env: | |
TAG: ${{ inputs.tag }} | |
steps: | |
- name: configure python | |
uses: actions/setup-python@v5 | |
with: | |
python-version: '3.9' | |
- name: configure git | |
uses: cylc/release-actions/configure-git@v1 | |
- name: checkout cylc-doc | |
uses: actions/checkout@v4 | |
with: | |
path: docs | |
- name: checkout gh-pages | |
uses: actions/checkout@v4 | |
with: | |
ref: gh-pages | |
path: gh-pages | |
- name: check tag | |
run: | | |
for ver in stable latest; do | |
ver_link="$(readlink gh-pages/${ver})" | |
if [[ -z "$ver_link" ]] | |
then | |
echo "::error::Could not determine the '"$ver"' version" | |
exit 1 | |
elif [[ "$ver" == "$TAG" ]] | |
then | |
echo "::error::Cannot delete the '"$ver"' version" | |
exit 1 | |
fi | |
done | |
- name: install gh-pages | |
working-directory: docs | |
run: | | |
rm -r doc | |
ln -s ../gh-pages doc | |
- name: remove version | |
working-directory: gh-pages | |
run: | | |
git rm -r "$TAG" | |
- name: update version file | |
working-directory: docs | |
run: | | |
bin/version write > doc/versions.json | |
- name: push changes | |
working-directory: gh-pages | |
run: | | |
git add -u | |
git commit -m "remove: ${TAG}" | |
git push origin HEAD |