emacs-eask · jcs090218 · Mar 7, 2023 · Mar 7, 2023 · Mar 7, 2023 · Mar 7, 2023
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -50,6 +50,7 @@ Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how
 * Move `pkg-file` and `autoloads` commands under `generate` subcommand (#142)
 * Add option to convert Cask to Eask (#141 and #145)
 * Add command to generate GHA workflow (#141 and #146)
+* Add commands to support all kind of CI platforms (#150)
 
 ## 0.7.x
 > Released Sep 08, 2022

diff --git a/cmds/generate/workflow/circle-ci.js b/cmds/generate/workflow/circle-ci.js
@@ -0,0 +1,36 @@
+/**
+ * Copyright (C) 2023 Jen-Chieh Shen
+ *
+ * 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, 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 GNU Emacs; see the file COPYING.  If not, write to the
+ * Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+ * Boston, MA 02110-1301, USA.
+ */
+
+"use strict";
+
+exports.command = ['circle-ci [file]'];
+exports.desc = 'Generate CircleCI workflow yaml file';
+exports.builder = {
+  file: {
+    description: 'name of the test file; the default is `config.yml`',
+    requiresArg: false,
+    type: 'array',
+    group: TITLE_CMD_OPTION,
+  },
+};
+
+exports.handler = async (argv) => {
+  await UTIL.e_call(argv, 'generate/workflow/circle-ci', argv.file);
+};
+
diff --git a/cmds/generate/workflow/github.js b/cmds/generate/workflow/github.js
@@ -19,7 +19,7 @@
 
 "use strict";
 
-exports.command = ['github [file]'];
+exports.command = ['github [file]', 'github-actions [file]', 'gha [file]'];
 exports.desc = 'Generate GitHub Actions workflow yaml file';
 exports.builder = {
   file: {

diff --git a/cmds/generate/workflow/gitlab.js b/cmds/generate/workflow/gitlab.js
@@ -0,0 +1,36 @@
+/**
+ * Copyright (C) 2023 Jen-Chieh Shen
+ *
+ * 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, 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 GNU Emacs; see the file COPYING.  If not, write to the
+ * Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+ * Boston, MA 02110-1301, USA.
+ */
+
+"use strict";
+
+exports.command = ['gitlab [file]', 'gitlab-runner [file]'];
+exports.desc = 'Generate GitLab Runner workflow yaml file';
+exports.builder = {
+  file: {
+    description: 'name of the test file; the default is `.gitlab-ci.yml`',
+    requiresArg: false,
+    type: 'array',
+    group: TITLE_CMD_OPTION,
+  },
+};
+
+exports.handler = async (argv) => {
+  await UTIL.e_call(argv, 'generate/workflow/gitlab', argv.file);
+};
+
diff --git a/cmds/generate/workflow/travis-ci.js b/cmds/generate/workflow/travis-ci.js
@@ -0,0 +1,36 @@
+/**
+ * Copyright (C) 2023 Jen-Chieh Shen
+ *
+ * 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, 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 GNU Emacs; see the file COPYING.  If not, write to the
+ * Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+ * Boston, MA 02110-1301, USA.
+ */
+
+"use strict";
+
+exports.command = ['travis-ci [file]'];
+exports.desc = 'Generate Travis CI workflow yaml file';
+exports.builder = {
+  file: {
+    description: 'name of the test file; the default is `.travis.yml`',
+    requiresArg: false,
+    type: 'array',
+    group: TITLE_CMD_OPTION,
+  },
+};
+
+exports.handler = async (argv) => {
+  await UTIL.e_call(argv, 'generate/workflow/travis-ci', argv.file);
+};
+
diff --git a/docs/content/en/Continuous Integration/CircleCI.md b/docs/content/en/Continuous Integration/CircleCI.md
@@ -14,9 +14,9 @@ default: &default-steps
     - checkout
     - run: apt-get update && apt-get install -y git
     - run: |
+        eask package
         eask install
         eask compile
-        eask lint package
 
 # Enumerated list of Emacs versions
 jobs:

diff --git a/docs/content/en/Continuous Integration/GitHub Actions.md b/docs/content/en/Continuous Integration/GitHub Actions.md
@@ -31,9 +31,9 @@ jobs:
 
     - name: Run tests
       run: |
+        eask package
         eask install
         eask compile
-        eask lint package
 ```
 
 This example is testing your Emacs Lisp package in the below environment;

diff --git a/docs/content/en/Continuous Integration/GitLab Runner.md b/docs/content/en/Continuous Integration/GitLab Runner.md
@@ -18,9 +18,9 @@ pages:
   - apt-get update
   - apt-get install emacs -y
   script:
+  - eask package
   - eask install
   - eask compile
-  - eask lint package
   only:
   - main
 ```

diff --git a/docs/content/en/Continuous Integration/Travis CI.md b/docs/content/en/Continuous Integration/Travis CI.md
@@ -25,9 +25,9 @@ install:
   - npm install @emacs-eask/cli -g
 
 script:
+  - eask package
   - eask install
   - eask compile
-  - eask lint package
 ```
 
 This example is testing your Emacs Lisp package in the below environment;

diff --git a/docs/content/en/Getting Started/Commands and options.md b/docs/content/en/Getting Started/Commands and options.md
@@ -331,12 +331,44 @@ $ eask [GLOBAL-OPTIONS] generate pkg-file
 [Multi-file Packages (elisp)](https://www.gnu.org/software/emacs/manual/html_node/elisp/Multi_002dfile-Packages.html#Multi_002dfile-Packages)
 for details.
 
+## 🔍 eask generate workflow circle-ci
+
+Generate CircleCI workflow yaml file.
+
+```sh
+$ eask [GLOBAL-OPTIONS] generate workflow circle-ci [--file]
+```
+
+{{< hint info >}}
+💡 This will generate the yaml file under `.circleci/`!
+{{< /hint >}}
+
 ## 🔍 eask generate workflow github
 
 Generate GitHub Actions workflow yaml file.
 
 ```sh
-$ eask [GLOBAL-OPTIONS] generate workflow github
+$ eask [GLOBAL-OPTIONS] generate workflow github [--file]
+```
+
+{{< hint info >}}
+💡 This will generate the yaml file under `.github/workflow/`!
+{{< /hint >}}
+
+## 🔍 eask generate workflow gitlab
+
+Generate GitLab Runner workflow yaml file.
+
+```sh
+$ eask [GLOBAL-OPTIONS] generate workflow gitlab [--file]
+```
+
+## 🔍 eask generate workflow travis-ci
+
+Generate Travis CI workflow yaml file.
+
+```sh
+$ eask [GLOBAL-OPTIONS] generate workflow travis-ci [--file]
 ```
 
 # 🚩 Linking

diff --git a/lisp/checker/check-eask.el b/lisp/checker/check-eask.el
@@ -7,9 +7,12 @@
 ;;   $ eask check-eask [FILES..]
 ;;
 ;;
-;;  Initialization options:
+;;  Positional arguments:
 ;;
 ;;    [files..]     specify Eask-files for checker to lint
+;;
+;; Optional arguments:
+;;
 ;;    --json        Output lint result in JSON format
 ;;
 

diff --git a/lisp/core/compile.el b/lisp/core/compile.el
@@ -7,7 +7,7 @@
 ;;   $ eask compile [names..]
 ;;
 ;;
-;;  Initialization options:
+;;  Positional arguments:
 ;;
 ;;    [names..]     specify files to byte-compile
 ;;

diff --git a/lisp/core/concat.el b/lisp/core/concat.el
@@ -7,7 +7,7 @@
 ;;   $ eask concat [names..]
 ;;
 ;;
-;;  Initialization options:
+;;  Positional arguments:
 ;;
 ;;    [names..]         specify files to concatenate
 ;;

diff --git a/lisp/core/emacs.el b/lisp/core/emacs.el
@@ -7,7 +7,7 @@
 ;;   $ eask emacs [args..]
 ;;
 ;;
-;;  Initialization options:
+;;  Positional arguments:
 ;;
 ;;    [args..]     arguments feed into Emacs executable
 ;;

diff --git a/lisp/core/exec.el b/lisp/core/exec.el
@@ -7,7 +7,7 @@
 ;;   $ eask exec [args..]
 ;;
 ;;
-;;  Initialization options:
+;;  Positional arguments:
 ;;
 ;;    [args..]     execute command with correct PATH set up
 ;;

diff --git a/lisp/core/install.el b/lisp/core/install.el
@@ -7,7 +7,7 @@
 ;;   $ eask install [names..]
 ;;
 ;;
-;;  Initialization options:
+;;  Positional arguments:
 ;;
 ;;    [names..]     name of the package to install; else we try to install
 ;;                  package from current directory by calling function

diff --git a/lisp/core/reinstall.el b/lisp/core/reinstall.el
@@ -7,7 +7,7 @@
 ;;   $ eask reinstall [names..]
 ;;
 ;;
-;;  Initialization options:
+;;  Positional arguments:
 ;;
 ;;    [names..]     name of the package to reinstall
 ;;

diff --git a/lisp/core/run.el b/lisp/core/run.el
@@ -7,7 +7,7 @@
 ;;   $ eask run [names..]
 ;;
 ;;
-;;  Initialization options:
+;;  Positional arguments:
 ;;
 ;;    [names..]     run the script named <foo>
 ;;

diff --git a/lisp/core/search.el b/lisp/core/search.el
@@ -7,7 +7,7 @@
 ;;   $ eask search [queries..]
 ;;
 ;;
-;;  Initialization options:
+;;  Positional arguments:
 ;;
 ;;    [queries..]     query to search packages
 ;;

diff --git a/lisp/core/uninstall.el b/lisp/core/uninstall.el
@@ -7,7 +7,7 @@
 ;;   $ eask uninstall [names..]
 ;;
 ;;
-;;  Initialization options:
+;;  Positional arguments:
 ;;
 ;;    [names..]     name of the package to uninstall; else we uninstall pacakge
 ;;                  from current workspace

diff --git a/lisp/core/upgrade.el b/lisp/core/upgrade.el
@@ -7,7 +7,7 @@
 ;;   $ eask upgrade [names..]
 ;;
 ;;
-;;  Initialization options:
+;;  Positional arguments:
 ;;
 ;;    [names..]     package to upgrade; else we upgrade all packages
 ;;

diff --git a/lisp/create/elpa.el b/lisp/create/elpa.el
@@ -7,7 +7,7 @@
 ;;   $ eask create elpa [name]
 ;;
 ;;
-;;  Initialization options:
+;;  Positional arguments:
 ;;
 ;;    [name]     new ELPA name
 ;;

diff --git a/lisp/create/package.el b/lisp/create/package.el
@@ -7,7 +7,7 @@
 ;;   $ eask create package [name]
 ;;
 ;;
-;;  Initialization options:
+;;  Positional arguments:
 ;;
 ;;    [name]     new project name
 ;;

diff --git a/lisp/generate/workflow/circle-ci.el b/lisp/generate/workflow/circle-ci.el
@@ -0,0 +1,37 @@
+;;; generate/workflow/circle-ci.el --- Generate CircleCI workflow yaml file  -*- lexical-binding: t; -*-
+
+;;; Commentary:
+;;
+;; Command use generate CircleCI test yaml file,
+;;
+;;   $ eask generate workflow circle-ci
+;;
+;;
+;;  Positional arguments:
+;;
+;;    [--file]     name of the test file; the default is `config.yml`
+;;
+
+;;; Code:
+
+(let ((dir (file-name-directory (nth 1 (member "-scriptload" command-line-args)))))
+  (load (expand-file-name "_prepare.el"
+                          (locate-dominating-file dir "_prepare.el"))
+        nil t))
+
+(eask-start
+  (let* ((url "https://raw.githubusercontent.com/emacs-eask/template-generate/master/workflow/circle-ci.yml")
+         (dir (expand-file-name ".circleci/"))
+         (basename (or (car (eask-args)) "config.yml"))
+         (filename (expand-file-name basename dir))
+         (minimum-version (car (cdr (nth 0 eask-depends-on-emacs)))))
+    (ignore-errors (make-directory dir t))
+    (if (file-exists-p filename)
+        (eask-info "The yaml file already exists `%s`" filename)
+      (eask-with-progress
+        (format "Generating file %s... " filename)
+        (eask-with-verbosity 'debug (url-copy-file url filename))
+        "done ✓")
+      (eask-info "✓ Successfully created the yaml file in `%s`" filename))))
+
+;;; generate/workflow/circle-ci.el ends here