feat(workflow): Add commands to support all kind of CI platforms (#150)

* feat(workflow): Add commands to support all kind of CI platforms

* changelog

* Fix comment title

Author: jcs090218

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

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);
+};
+

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: {

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);
+};
+

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);
+};
+

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:

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;

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
 ```

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;

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