Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Installer] Add yq (for editing YAML configs) #130

Closed
11 tasks
coolaj86 opened this issue Sep 22, 2020 · 4 comments
Closed
11 tasks

[Installer] Add yq (for editing YAML configs) #130

coolaj86 opened this issue Sep 22, 2020 · 4 comments

Comments

@coolaj86
Copy link
Member

coolaj86 commented Sep 22, 2020

Add yq

https://github.com/mikefarah/yq

We want to add yq because it can make configuring config.yml files (such as alacrittys config file) much easier than writing custom code.

It's written in go, so it works consistently across Windows, Mac, and Linux.

This could be as simple as copying _example, updating the github releases
info, and doing a find and replace on a few file system path names.

How to create a webi installer

Video Tutorial: How to create a webi Installer

Skills required

  • Basic Command Line knowledge (mkdir, mv, ls, tar, unzip, variables)

Steps

  1. Clone and setup the webi packages repo
    git clone git@github.com:webinstall/packages.git
    pushd packages/
    npm install
  2. Copy the example template and update with info from Official Releases:
    https://github.com/mikefarah/yq/releases
    rsync -av ./_example/ ./yq/
    • update yq/release.js to use the official repo
    • Learn how yq unpacks (i.e. as a single file? as a .tar.gz? as
      a .tar.gz with a folder named yq?)
    • find and replace to change the name
      • update yq/install.sh (see bat and jq as examples)
      • update yq/install.ps1 (see bat and jq as examples)
  3. Needs an updated tagline and cheat sheet
    • update yq/README.md
      • official URL
      • tagline
      • Switch versions
      • description / summary
      • General pointers on usage (and perhaps "gotchas")

It's also okay to have multiple people work on part of this (i.e. the Cheat
Sheet can be done independently from the install.sh)

@coolaj86
Copy link
Member Author

Things to make sure we have in the README:

(see the yq docs on their homepage)

  • how to set an existing value nested in an object
  • how to set an existing value nested in an array
  • how to create a new value
  • how to delete a value

@coolaj86 coolaj86 changed the title [Installer] Add yq [Installer] Add yq (for editing YAML configs) Sep 22, 2020
@proxium
Copy link

proxium commented Oct 16, 2020

@coolaj86 I would like to take this.

@coolaj86
Copy link
Member Author

coolaj86 commented Dec 2, 2020

@proxium Are you still interested in this?

@adithyasunil26
Copy link
Contributor

Please check #169

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants