fix(workflow): Update workflows (#154)

jcs090218 · web-flow · commit 6151313d5d34 · 2023-03-07T18:22:18.000-08:00
* fix(workflow): Update workflows

* Add more docs

* Make sure align

* fix whitespace

* docs(README.md): Update instructions

* update
diff --git a/docs/content/en/Continuous Integration/CircleCI.md b/docs/content/en/Continuous Integration/CircleCI.md
@@ -5,43 +5,138 @@ weight: 400
 
 {{< toc >}}
 
+[![Windows](https://img.shields.io/badge/-Windows-lightblue?logo=windows&style=flat&logoColor=blue)](#)
+[![macOS](https://img.shields.io/badge/-macOS-lightgrey?logo=apple&style=flat&logoColor=white)](#)
+[![Linux](https://img.shields.io/badge/-Linux-fcc624?logo=linux&style=flat&logoColor=black)](#)
+
 Example to use [Circle CI](https://circleci.com/).
 
 ```yml
+version: 2.1
+
+orbs:
+  win: circleci/windows@2.2.0
+
 # Default actions to perform on each Emacs version
-default: &default-steps
-  steps:
-    - checkout
-    - run: apt-get update && apt-get install -y git
-    - run: |
-        eask package
-        eask install
-        eask compile
-
-# Enumerated list of Emacs versions
+commands:
+  setup-linux:
+    steps:
+      - checkout
+      - run:
+          name: Install unzip
+          command: apt-get update && apt-get install unzip
+      - run:
+          name: Install Eask
+          command: curl -fsSL https://raw.githubusercontent.com/emacs-eask/cli/master/webinstall/install.sh | sh
+
+  setup-macos:
+    steps:
+      - checkout
+      - run:
+          name: Install Emacs latest
+          command: |
+            echo "HOMEBREW_NO_AUTO_UPDATE=1" >> $BASH_ENV
+            brew install homebrew/cask/emacs
+      - run:
+          name: Install unzip
+          command: apt-get update && apt-get install unzip
+      - run:
+          name: Install Eask
+          command: curl -fsSL https://raw.githubusercontent.com/emacs-eask/cli/master/webinstall/install.sh | sh
+
+  setup-windows:
+    steps:
+      - checkout
+      - run:
+          name: Install Eask
+          command: url.exe -fsSL https://raw.githubusercontent.com/emacs-eask/cli/master/webinstall/install.bat | cmd /Q
+
+  test:
+    steps:
+      - run:
+          name: Run regression tests
+          command: eldev -dtT -p test
+  lint:
+    steps:
+      - run:
+          name: Run Elisp-lint
+          command: eldev lint
+      - run:
+          name: Byte-compile `.el' files
+          command: eldev -dtT compile --warnings-as-errors
+
 jobs:
-  test-emacs-26:
+  test-ubuntu-emacs-26:
+    docker:
+      - image: silex/emacs:26-ci
+        entrypoint: bash
+    steps:
+      - setup-linux
+      - test
+
+  test-ubuntu-emacs-27:
+    docker:
+      - image: silex/emacs:27-ci
+        entrypoint: bash
+    steps:
+      - setup-linux
+      - test
+
+  test-ubuntu-emacs-28:
     docker:
-      - image: silex/emacs:26.2
+      - image: silex/emacs:28-ci
         entrypoint: bash
-    <<: *default-steps
+    steps:
+      - setup-linux
+      - test
 
-  test-emacs-master:
+  test-ubuntu-emacs-master:
     docker:
-      - image: silex/emacs:master
+      - image: silex/emacs:master-ci
         entrypoint: bash
-    <<: *default-steps
+    steps:
+      - setup-linux
+      - test
+
+  test-macos-emacs-latest:
+    macos:
+      xcode: "14.0.0"
+    steps:
+      - setup-macos
+      - test
+
+  test-windows-emacs-latest:
+    executor: win/default
+    steps:
+      - run:
+          name: Install Emacs latest
+          command: |
+            choco install emacs
+      - setup-windows
+      - test
 
-# Executing in parallel
 workflows:
   version: 2
   ci-test-matrix:
     jobs:
-      - test-emacs-26
-      - test-emacs-master
+      - test-ubuntu-emacs-26
+      - test-ubuntu-emacs-27
+      - test-ubuntu-emacs-28
+      - test-ubuntu-emacs-master
+      - test-macos-emacs-latest
+      - test-windows-emacs-latest
 ```
 
 This example is testing your Emacs Lisp package in the below environment;
 
-* Emacs: `26.2` and `snapshot`
-* Eask: `snapshot` (latest)
+| OS             | Emacs                              | Eask   |
+|----------------|------------------------------------|--------|
+| Linux (Ubuntu) | `26.x`, `27.x`, `28.x`, `snapshot` | latest |
+| macOS          | `snapshot`                         | latest |
+| Windows        | `snapshot`                         | latest |
+
+{{< hint info >}}
+💡 You can generate workflow file via `eask generate workflow circle-ci`, see 
+[Commands and options](https://emacs-eask.github.io/Getting-Started/Commands-and-options/#-eask-generate-workflow-circle-ci)
+for more information!
+{{< /hint >}}
diff --git a/docs/content/en/Continuous Integration/GitHub Actions.md b/docs/content/en/Continuous Integration/GitHub Actions.md
@@ -5,6 +5,10 @@ weight: 100
 
 {{< toc >}}
 
+[![Windows](https://img.shields.io/badge/-Windows-lightblue?logo=windows&style=flat&logoColor=blue)](#)
+[![macOS](https://img.shields.io/badge/-macOS-lightgrey?logo=apple&style=flat&logoColor=white)](#)
+[![Linux](https://img.shields.io/badge/-Linux-fcc624?logo=linux&style=flat&logoColor=black)](#)
+
 Here is an example using the [GitHub](https://github.com/) Actions service.
 
 ```yml
@@ -14,7 +18,7 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest, macos-latest, windows-latest]
-        emacs-version: [26.3, 27.2, 28.1, snapshot]
+        emacs-version: [26.3, 27.2, 28.2, snapshot]
 
     steps:
     - uses: actions/checkout@v2
@@ -38,14 +42,23 @@ jobs:
 
 This example is testing your Emacs Lisp package in the below environment;
 
-* Emacs: `27.2` and `snapshot`
-* Eask: `snapshot` (latest)
+| OS             | Emacs                              | Eask   |
+|----------------|------------------------------------|--------|
+| Linux (Ubuntu) | `26.x`, `27.x`, `28.x`, `snapshot` | latest |
+| macOS          | `26.x`, `27.x`, `28.x`, `snapshot` | latest |
+| Windows        | `26.x`, `27.x`, `28.x`, `snapshot` | latest |
 
 with these following `actions`,
 
 * [setup-emacs](https://github.com/jcs090218/setup-emacs) to install Emacs
 * [setup-eask](https://github.com/emacs-eask/setup-eask) to install desired Eask version
 
+{{< hint info >}}
+💡 You can generate workflow file via `eask generate workflow github`, see 
+[Commands and options](https://emacs-eask.github.io/Getting-Started/Commands-and-options/#-eask-generate-workflow-github)
+for more information!
+{{< /hint >}}
+
 ## 💾 Setup Eask locally
 
 You can install Eask locally using scripts from `.github/scripts/setup-eask` (Unix)
diff --git a/docs/content/en/Continuous Integration/GitLab Runner.md b/docs/content/en/Continuous Integration/GitLab Runner.md
@@ -5,27 +5,53 @@ weight: 200
 
 {{< toc >}}
 
+[![Linux](https://img.shields.io/badge/-Linux-fcc624?logo=linux&style=flat&logoColor=black)](#)
+
 Example to use [GitLab](https://gitlab.com/) runner.
 
 ```yml
 default:
-  image: node:16
-
-pages:
-  stage: test
   before_script:
-  - npm install @emacs-eask/cli -g
-  - apt-get update
-  - apt-get install emacs -y
+    - apt-get update
+    - apt-get install unzip
+    - curl -fsSL https://raw.githubusercontent.com/emacs-eask/cli/master/webinstall/install.sh | sh
+    - export PATH="$HOME/.local/bin:$PATH"
+
+test-26.3:
+  image: silex/emacs:26.3-ci
+  script:
+    - eask clean all
+    - eask package
+    - eask install
+    - eask compile
+
+test-27.2:
+  image: silex/emacs:27.2-ci
+  script:
+    - eask clean all
+    - eask package
+    - eask install
+    - eask compile
+
+test-28.2:
+  image: silex/emacs:28.2-ci
   script:
-  - eask package
-  - eask install
-  - eask compile
-  only:
-  - main
+    - eask clean all
+    - eask package
+    - eask install
+    - eask compile
 ```
 
 This example is testing your Emacs Lisp package in the below environment;
 
-* Emacs: `snapshot`
-* Eask: `snapshot` (latest)
+| OS             | Emacs                              | Eask   |
+|----------------|------------------------------------|--------|
+| Linux (Debian) | `26.x`, `27.x`, `28.x`, `snapshot` | latest |
+| macOS          | n/a                                | latest |
+| Windows        | n/a                                | latest |
+
+{{< hint info >}}
+💡 You can generate workflow file via `eask generate workflow gitlab`, see 
+[Commands and options](https://emacs-eask.github.io/Getting-Started/Commands-and-options/#-eask-generate-workflow-gitlab)
+for more information!
+{{< /hint >}}
diff --git a/docs/content/en/Continuous Integration/Travis CI.md b/docs/content/en/Continuous Integration/Travis CI.md
@@ -5,24 +5,32 @@ weight: 300
 
 {{< toc >}}
 
+[![Linux](https://img.shields.io/badge/-Linux-fcc624?logo=linux&style=flat&logoColor=black)](#)
+
 Example to use [Travis CI](https://www.travis-ci.com/).
 
 ```yml
-language: node_js
-node_js:
-  - 16
+language: nix
+
+os:
+  - linux
+  - osx
 
 env:
-  - EVM_EMACS=emacs-27.2-travis-linux-xenial
-  - EVM_EMACS=emacs-git-snapshot-travis-linux-xenial
+  - EMACS_CI=emacs-26-3
+  - EMACS_CI=emacs-27-2
+  - EMACS_CI=emacs-28-2
+  - EMACS_CI=emacs-snapshot
 
 matrix:
   fast_finish: true
   allow_failures:
-    - env: EVM_EMACS=emacs-git-snapshot-travis-linux-xenial
+    - env: EMACS_CI=emacs-snapshot
 
 install:
-  - npm install @emacs-eask/cli -g
+  - bash <(curl https://raw.githubusercontent.com/purcell/nix-emacs-ci/master/travis-install)
+  - curl -fsSL https://raw.githubusercontent.com/emacs-eask/cli/master/webinstall/install.sh | sh
+  - export PATH="$HOME/.local/bin:$PATH"
 
 script:
   - eask package
@@ -32,5 +40,15 @@ script:
 
 This example is testing your Emacs Lisp package in the below environment;
 
-* Emacs: `27.2` and `snapshot`
-* Eask: `snapshot` (latest)
+| OS             | Emacs                              | Eask   |
+|----------------|------------------------------------|--------|
+| Linux (Ubuntu) | `26.x`, `27.x`, `28.x`, `snapshot` | latest |
+| macOS          | n/a                                | latest |
+| Windows        | n/a                                | latest |
+
+
+{{< hint info >}}
+💡 You can generate workflow file via `eask generate workflow travis-ci`, see 
+[Commands and options](https://emacs-eask.github.io/Getting-Started/Commands-and-options/#-eask-generate-workflow-travis-ci)
+for more information!
+{{< /hint >}}
diff --git a/docs/content/en/Getting Started/Directory Structure.md b/docs/content/en/Getting Started/Directory Structure.md
@@ -10,7 +10,6 @@ a directory with the following structure:
 
 ```
 .
-├── .github/workflows/test.yml
 ├── .gitignore
 ├── Makefile
 ├── Eask
@@ -22,12 +21,6 @@ a directory with the following structure:
 
 The following is a high-level overview of each of the files.
 
-`.github/workflows/test.yml`
-
-GitHub actions workflow file that is read by GitHub Actions. This file has
-setups the basic environment for you to test your elisp project. Like, such
-as installing Emacs, setup Eask, etc.
-
 `.gitignore`
 
 Gitignore file, to ignore files you don't like to include from your repository.
@@ -52,5 +45,5 @@ from your repository.
 `{package-file}.el`
 
 This is the main package file; where you should write your elisp code.
-If you attempt to create a multiple-file packages; you would need to
+If you attempt to create a multiple-file package; you would need to
 edit the `Eask`-file accordingly.
diff --git a/docs/content/en/Getting Started/Quick Start.md b/docs/content/en/Getting Started/Quick Start.md
@@ -9,7 +9,7 @@ Using Eask as your Emacs package management tool.
 
 {{< hint info >}}
 The installation are cross-platform, using [npm](https://www.npmjs.com/).
-For instruction about how to install Eask with other methods, see [install](https://emacs-eask.github.io/Getting-Started/Install-Eask/).
+For instructions about how to install Eask with other methods, see [install](https://emacs-eask.github.io/Getting-Started/Install-Eask/).
 
 It is required to have [Git installed](https://git-scm.com/downloads)
 to run this tutorial.
diff --git a/lisp/generate/workflow/circle-ci.el b/lisp/generate/workflow/circle-ci.el
diff --git a/lisp/generate/workflow/gitlab.el b/lisp/generate/workflow/gitlab.el
