Skip to content

Commit

Permalink
Merge pull request #120 from jessebot/119-fix-g-devops-flag-failing-o…
Browse files Browse the repository at this point in the history
…n-macos

119 fix -g flag on macos; add version to --help, fix to XDG config; use yaml instead of yml
  • Loading branch information
cloudymax authored Dec 16, 2022
2 parents a459e4e + 8f5a583 commit 9509ea1
Show file tree
Hide file tree
Showing 12 changed files with 288 additions and 238 deletions.
2 changes: 1 addition & 1 deletion docs/onboardme/features.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,4 +61,4 @@ some dot files anyway, but we won't overwrite anything you have locally.
</details>

[default dot files]: https://github.com/jessebot/dot_files "default dot files"
[default packages.yaml]: https://github.com/jessebot/onboardme/blob/main/onboardme/config/packages.yml "default packages.yaml"
[default packages.yaml]: https://github.com/jessebot/onboardme/blob/main/onboardme/config/packages.yaml "default packages.yaml"
18 changes: 9 additions & 9 deletions docs/onboardme/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,15 +42,15 @@ onboardme --help
Those defaults can be altered per machine by creating a config file like:

<details>
<summary>`~/.config/onboardme/config.yml`</summary>
<summary>`~/.config/onboardme/config.yaml`</summary>

```yaml
---
# ______________________________________________________________ #
# Config file for the onboardme cli command. #
# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ #
# - This is the default config file that pip will install into: #
# $PYTHON_PATH/lib/onboardme/config/onboardme_config.yml #
# $PYTHON_PATH/lib/onboardme/config/onboardme_config.yaml #
# #
# - If this files exists as: ~/.config/onboardme/config.yaml #
# then its loaded instead of the default config #
Expand Down Expand Up @@ -130,7 +130,7 @@ Those defaults can be altered per machine by creating a config file like:
</details>
We also use a package file called
[`packages.yml`](https://github.com/jessebot/onboardme/blob/main/onboardme/config/packages.yml)
[`packages.yaml`](https://github.com/jessebot/onboardme/blob/main/onboardme/config/packages.yaml)
which you can also place in your `~/.config/onboardme` directory, to take
precedence over our defaults.

Expand All @@ -146,7 +146,7 @@ configured for both macOS and Linux seperately. These steps include:
- setting up basic TUI IDEs, vim/neovim
- setting up groups

They can be configured via the `steps` parameter in the `config.yml` above,
They can be configured via the `steps` parameter in the `config.yaml` above,
or via the the cli like:

```bash
Expand All @@ -173,15 +173,15 @@ The dot files for your home directory are installed from a git URL and branch
that you can configure either via the config file, or the cli. If your local
files conflict with the files in the repo, we will not overwrite them by default.
If you always want your local dot files overwritten, you can pass in the `-O` switch
or `--overwrite` option or set `overwrite` in your local `~/.config/onboardme/config.yml`.
or `--overwrite` option or set `overwrite` in your local `~/.config/onboardme/config.yaml`.

### `onboardme` cli
```bash
# run onboardme with a custom git url and branch that overwrites existing files
onboardme --git_url https://github.com/jessebot/dot_files.git --git_branch main --overwrite
```

### `config.yml`
### `config.yaml`

```yaml
dot_files:
Expand All @@ -194,7 +194,7 @@ dot_files:
### Package Management
All of the packages are installed using package managers, and each package
manager has groups of packages they can install. You can specify specific
package _managers_ and package _groups_ via the `config.yml` file, or via the cli.
package _managers_ and package _groups_ via the `config.yaml` file, or via the cli.

By default, we install the `default` package _groups_ for all package _managers_.
This includes everything you need for a basic cli experience and a slim ide.
Expand All @@ -216,7 +216,7 @@ slim ide PLUS GUI tools, like vlc and freetube.
onboardme --pkg_groups default --pkg_groups gui
```

##### `config.yml`
##### `config.yaml`

```yaml
package:
Expand All @@ -236,7 +236,7 @@ _Note: This will not install/upgrade the default package group._
onboardme --pkg_managers brew --pkg_groups devops
```

##### `config.yml`
##### `config.yaml`

```yaml
package:
Expand Down
4 changes: 2 additions & 2 deletions docs/onboardme/onboardme.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@ This is [a project](https://github.com/jessebot/onboardme) to store config files
| Step | Config Location in repo | OS |
|--------------------------------------|------------------------------------------|---------------|
| Git fetch dot files | n/a: fetched from a configured git repo | macOS/Debian |
| Installs apps using package managers | `./onboardme/config/packages.yml` | Debian, macOS |
| Installs OPTIONAL apps | `./onboardme/config/packages.yml` | Debian |
| Installs apps using package managers | `./onboardme/config/packages.yaml` | Debian, macOS |
| Installs OPTIONAL apps | `./onboardme/config/packages.yaml` | Debian |
| Installs fonts | n/a | macOS/Debian |
| Installs vim-plug + vim plugins | plugins fetched from configured git repo | macOS/Debian |
| Installs packer.nvm + neovim plugins | plugins fetched from configured git repo | macOS/Debian |
Expand Down
Loading

0 comments on commit 9509ea1

Please sign in to comment.