From 31b217acd6943f462336d7cf812b75a5dce761b8 Mon Sep 17 00:00:00 2001
From: Anton Gilgur <agilgur5@gmail.com>
Date: Sun, 28 Aug 2022 13:05:10 -0400
Subject: [PATCH] ci: rename `travis` -> `ci` and modify CI docs

- now that GH Actions are merged, thoroughly tested, and working:
  - rename `travis` dir to `ci` dir instead
  - update `release.md` to remove Travis references and reference GH Actions files instead
    - and just generic "ci build" instead of "travis build"
    - CI is working now, so uncomment/unquote the previous numbers

- leave `cp_to_travis` and `reverse_ssh_tunnel` as is for now, in case Sylvain wants to adapt them to GH Actions
  - I'm not sure they'll work as-is on GH Actions (e.g. `travis_base` won't exist), so they may need further modification
    - (or it may not be possible at all with GH Actions to do reverse SSH)
    - that is beyond my scope since I'm not using these, don't have a bounce host, and am developing on a Mac locally
---
 .github/workflows/ci.yml             |  6 ++---
 {travis => ci}/cp_to_travis.sh       |  2 +-
 {travis => ci}/get_bash5_macos.sh    |  1 -
 {travis => ci}/get_bats-core.sh      |  0
 {travis => ci}/reverse_ssh_tunnel.sh |  3 +--
 docs/release.md                      | 37 ++++++++++++++--------------
 6 files changed, 23 insertions(+), 26 deletions(-)
 rename {travis => ci}/cp_to_travis.sh (97%)
 rename {travis => ci}/get_bash5_macos.sh (96%)
 rename {travis => ci}/get_bats-core.sh (100%)
 rename {travis => ci}/reverse_ssh_tunnel.sh (94%)

diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
index ccab3d3..97b9dc5 100644
--- a/.github/workflows/ci.yml
+++ b/.github/workflows/ci.yml
@@ -27,8 +27,8 @@ jobs:
       run: |
         bash --version ; type bash
         # hack for speedup on mac build with our own bash5
-        ./travis/get_bash5_macos.sh
-        ./travis/get_bats-core.sh
+        ./ci/get_bash5_macos.sh
+        ./ci/get_bats-core.sh
         go get github.com/docopt/docopt-go
         # get our official repos too
         go get github.com/docopt/docopts
@@ -38,4 +38,4 @@ jobs:
       # For debugging, create reverse SSH tunnel (this should be run on failure too)
       # - name: Debug
       #   if: runner.os == "macOS"
-      #   run: bash -x ./travis/reverse_ssh_tunnel.sh
+      #   run: bash -x ./ci/reverse_ssh_tunnel.sh
diff --git a/travis/cp_to_travis.sh b/ci/cp_to_travis.sh
similarity index 97%
rename from travis/cp_to_travis.sh
rename to ci/cp_to_travis.sh
index 99ff248..e8cd1b0 100755
--- a/travis/cp_to_travis.sh
+++ b/ci/cp_to_travis.sh
@@ -1,6 +1,6 @@
 #!/usr/bin/env bash
 #
-# Usage: ./travis/cp_to_travis.sh LOCAL_FILENAME
+# Usage: ./ci/cp_to_travis.sh LOCAL_FILENAME
 #
 # require: a bounce host MUST be set before!
 
diff --git a/travis/get_bash5_macos.sh b/ci/get_bash5_macos.sh
similarity index 96%
rename from travis/get_bash5_macos.sh
rename to ci/get_bash5_macos.sh
index 61d862e..b312030 100755
--- a/travis/get_bash5_macos.sh
+++ b/ci/get_bash5_macos.sh
@@ -28,6 +28,5 @@ type bash
 MY_BASH_VERSINFO=$(bash --version | sed -n -e '1 s/^.*version \([0-9.]\{1,\}\).*/\1/ p')
 if [[ ! $MY_BASH_VERSINFO =~ ^[4-9] ]] ; then
   echo "install bash5 failed"
-  # ./travis/reverse_ssh_tunnel.sh
   exit 1
 fi
diff --git a/travis/get_bats-core.sh b/ci/get_bats-core.sh
similarity index 100%
rename from travis/get_bats-core.sh
rename to ci/get_bats-core.sh
diff --git a/travis/reverse_ssh_tunnel.sh b/ci/reverse_ssh_tunnel.sh
similarity index 94%
rename from travis/reverse_ssh_tunnel.sh
rename to ci/reverse_ssh_tunnel.sh
index 37093f7..0833226 100755
--- a/travis/reverse_ssh_tunnel.sh
+++ b/ci/reverse_ssh_tunnel.sh
@@ -1,7 +1,6 @@
 #!/usr/bin/env bash
 #
-# Usage: add this line to .travis.yml at the end of the script: section
-#  - if [[ "$TRAVIS_OS_NAME" == "osx" ]]; then bash -x ./travis/reverse_ssh_tunnel.sh ; fi
+# Usage: uncomment the reverse_ssh_tunnel lines in .github/workflows/ci.yml at the bottom of the file
 # required: a bounce host MUST be set before!
 # NOTE: ansible playbook to build the bounce_host not provided yet.
 
diff --git a/docs/release.md b/docs/release.md
index 6da20d9..41d615b 100644
--- a/docs/release.md
+++ b/docs/release.md
@@ -44,25 +44,24 @@ git checkout master
 git commit -a
 ```
 
-TRAVIS CI is gone, #54
-> ## 5. push on origin for a travis build
->
-> ```
-> git push origin master
-> ```
->
-> ## 6. remove travis hack macos if any
->
-> ```
-> sed -i -e '/travis.reverse_ssh_tunnel.sh/ s/^\([^#]\)/#\1/' .travis.yml
-> ```
->
-> ## 7. push on docopts for a travis build
->
-> ```
-> git commit -a
-> git push docopts master
-> ```
+## 5. push on origin for a ci build
+
+```
+git push origin master
+```
+
+## 6. remove reverse ssh hack macos if any
+
+```
+sed -i -e '/ci.reverse_ssh_tunnel.sh/ s/^\([^#]\)/#\1/' .github/workflows/ci.yml
+```
+
+## 7. push on docopts for a ci build
+
+```
+git commit -a
+git push docopts master
+```
 
 ## 8. tag the new release