.github/ISSUE_TEMPLATE/new_installer.md

   1 ---
   2 name: New Installer
   3 about: Create a new installer for webinstall.dev
   4 title: '[Installer] Add CHANGE-ME'
   5 labels:
   6   - 'good first issue'
   7   - first-timers-only
   8   - up-for-grabs
   9 ---
  10
  11 # Add CHANGE-ME
  12
  13 We want to add `CHANGE-ME` because...
  14
  15 - it works consistently across Windows, Mac, and Linux.
  16
  17 This could be as simple as copying `_example`, updating the github releases
  18 info, and doing a find and replace on a few file system path names.
  19
  20 # How to create a webi installer
  21
  22 [![Video Tutorial: How to create a webi Installer](https://user-images.githubusercontent.com/122831/91064908-17f28100-e5ed-11ea-9cf0-ab3363cdf4f8.jpeg)](https://youtu.be/RDLyJtiyQHA)
  23
  24 ## Skills required
  25
  26 - Basic Command Line knowledge (`mkdir`, `mv`, `ls`, `tar`, `unzip`, variables)
  27
  28 ## Steps
  29
  30 1. Clone and setup the webi packages repo
  31    ```bash
  32    git clone git@github.com:webinstall/packages.git
  33    pushd packages/
  34    npm install
  35    ```
  36 2. Copy the example template and update with info from Official Releases:
  37    <https://github.com/___CHANGE/ME___/releases>
  38    ```bash
  39    rsync -av _example/ CHANGE-ME/
  40    ```
  41    - [ ] update `CHANGE-ME/release.js` to use the official repo
  42    - [ ] Learn how `CHANGE-ME` unpacks (i.e. as a single file? as a .tar.gz? as
  43          a .tar.gz with a folder named CHANGE-ME?)
  44    - [ ] find and replace to change the name
  45      - [ ] update `CHANGE-ME/install.sh` (see `bat` and `jq` as examples)
  46      - [ ] update `CHANGE-ME/install.ps1` (see `bat` and `jq` as examples)
  47 3. Needs an updated tagline and cheat sheet
  48    - [ ] update `CHANGE-ME/README.md`
  49      - [ ] official URL
  50      - [ ] tagline
  51      - [ ] Switch versions
  52      - [ ] description / summary
  53      - [ ] General pointers on usage (and differences from `sed`)
  54
  55 It's also okay to have multiple people work on part of this (i.e. the Cheat
  56 Sheet can be done independently from the `install.sh`)