gh-pages-squash: Transition from TravisCI to GitHub action

* Simplify and generalize script "gh-pages-squash.sh" to support only
  squash mode.

* Add GitHub actions workflow triggering execution of the gh-pages-squash.sh
  script

* Rename trigger-travis-squash.sh to trigger-workflow-squash.sh and update
  to use GitHub API.

Author: jcfr

.github/workflows/gh-pages-squash.yml

@@ -0,0 +1,20 @@
+name: Squash gh-pages branch
+
+on:
+  schedule:
+    # Every tuesday at 11.30am UTC (7.30am ET)
+    - cron: "30 11 * * 2"
+  workflow_dispatch:
+
+jobs:
+  gh-pages-reset:
+    name: Squash gh-pages branch
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Squash gh-pages branch
+        run: |
+          ./gh-pages-squash.sh
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.travis.yml

@@ -18,43 +18,30 @@ The simple GitHub post-receive web hook handler triggering a CircleCI build is
 [github-circleci-trigger](https://github.com/Slicer/github-circleci-trigger). It is implemented as
 a Flask application hosted on a free heroku instance.
 
-## Squash of `gh-pages` branch using TravisCI Cron Job
+## Squash of `gh-pages` branch using a scheduled GitHub Actions worklfow
 
 After some time, the amount of data published on the `gh-pages` exceeds GitHub [recommended size of 1GB][max_size].
-To cleanup the repository, a [TravisCI Cron Job][cronjob] associated with this project
+To cleanup the repository, a [scheduled workflow][schedule] associated with this project
 will be triggered weekly and will execute [gh-pages-squash.sh](./gh-pages-squash.sh) script.
 
 The script simply do a soft reset, amend the first commit and force push the branch `gh-pages`.
 
-Last TravisCI Cron Job: [![Build Status][travis_img]][travis]
-
 [max_size]: https://help.github.com/articles/what-is-my-disk-quota/
-[cronjob]: https://docs.travis-ci.com/user/cron-jobs/
-[travis]: https://travis-ci.org/Slicer/apidocs.slicer.org
-[travis_img]: https://travis-ci.org/Slicer/apidocs.slicer.org.svg?branch=main
+[schedule]: https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#schedule
 
 
-## Programmatically request updates of `gh-pages` branch using TravisCI API
+## Programmatically request updates of `gh-pages` branch using GitHub API
 
 ### Prequisites
 
-* Install Travis client
-
-```
-# Install travis client
-curl https://raw.githubusercontent.com/jcfr/docker-travis-cli/master/travis-cli.sh \
-  -o ~/bin/travis-cli && \
-chmod +x ~/bin/travis-cli
-```
-
 * Generate GitHub token - See [here](https://github.com/settings/tokens)
 
 ### Squash *gh-pages*
 
-*This is useful to debug the TravisCI Cron Jobs without having to wait.*
+*This is useful to debug the workflow without having to wait.*
 
 ```
-GITHUB_TOKEN=<YOUR_GITHUB_TOKEN> ./trigger-travis-squash.sh squash
+GITHUB_TOKEN=<YOUR_GITHUB_TOKEN> ./trigger-workflow-squash.sh
 ```
 
 # license

README.md

@@ -4,22 +4,16 @@ set -e
 set -o pipefail
 set -x
 
-UPDATE_MODE=$TRAVIS_EVENT_TYPE
+UPDATE_MODE=${UPDATE_MODE:-squash}
 
 SCRIPT_NAME=$(basename $0)
 
-case $TRAVIS_EVENT_TYPE in
-cron)
-  UPDATE_MODE="squash"
-  WHO="Travis Cron job"
-  echo "$SCRIPT_NAME: executed from $WHO [UPDATE_MODE defaults to $UPDATE_MODE]"
-  ;;
+case $UPDATE_MODE in
 squash)
-  WHO="Travis API"
-  echo "$SCRIPT_NAME: executed from $WHO [UPDATE_MODE=$UPDATE_MODE]"
+  echo "$SCRIPT_NAME: executed with [UPDATE_MODE=$UPDATE_MODE]"
   ;;
 *)
-  echo "$SCRIPT_NAME: skipping because invalid TRAVIS_EVENT_TYPE value. Accepted values are 'cron' or 'squash'"
+  echo "$SCRIPT_NAME: skipping because invalid UPDATE_MODE value. Accepted values are 'squash'"
   exit 1
   ;;
 esac
@@ -44,7 +38,7 @@ if [[ $UPDATE_MODE == "squash" ]]; then
   git checkout -b $TARGET_BRANCH FETCH_HEAD
   first_commit=$(git rev-list --max-parents=0 HEAD)
   git reset --soft $first_commit
-  git commit --amend -m "Slicer apidocs squashed by $WHO
+  git commit --amend -m "Slicer apidocs squashed
 
 It was automatically generated by the script ``$SCRIPT_NAME`` [1]
 

gh-pages-squash.sh

@@ -0,0 +1,39 @@
+#!/usr/bin/env bash
+
+set -e
+set -o pipefail
+
+SCRIPT_NAME=$(basename $0)
+UPDATE_MODE=${1:-squash}
+
+usage() {
+    echo ""
+    echo "Usage: $0 [squash]"
+    echo ""
+}
+
+# Sanity checks
+if [[ -z $GITHUB_TOKEN ]]; then
+  echo "$SCRIPT_NAME: skipping because GITHUB_TOKEN env. variable is not set"
+  exit 1
+fi
+
+case $UPDATE_MODE in
+squash)
+  ;;
+*)
+  echo "$SCRIPT_NAME: invalid parameters"
+  usage
+  exit 1
+  ;;
+esac
+
+GITHUB_REPO="Slicer/apidocs.slicer.org"
+GITHUB_WORKFLOW_ID="gh-pages-squash.yml"
+
+curl \
+    -X POST \
+    -H "Accept: application/vnd.github+json" \
+    -H "Authorization: token ${GITHUB_TOKEN}" \
+    "https://api.github.com/repos/${GITHUB_REPO}/actions/workflows/${GITHUB_WORKFLOW_ID}/dispatches" \
+    -d '{"ref":"main"}'