1
0
Fork 0
mirror of synced 2024-11-22 16:25:34 -05:00
Commit graph

263 commits

Author SHA1 Message Date
Clumsy-Coder
974156ccde docs(readme): add docs for using shell conditionally
## what
  - add documentation on using shell command conditionally

  ## how

  ## why

  ## where

  ## usage
2022-08-11 21:12:47 -06:00
Clumsy-Coder
25ef5d5a5f feat(shell): run shell command conditionally
## what
  - add feature to run shell command (optionally)

  ## how
  - the shell directive will check if the 'if' property is available.
    If it is, it will run the command in 'if' property.
    If the command results in a return 0 code or 'true', then the
    'command' property will run.
    If the condition to run the command is a non 0 code or 'false',
      the shell command won't run
  - dotbot config example:
    ```yaml
    - shell:
        - command: echo "this is running on a MacOS"
          if: uname -s | grep -i "Darwin"
    ```
  - dotbot config example: skipping command if false
    ```yaml
    - shell:
        - command: echo "This command should be skipped"
          if: false
    ```

  ## why
  - can run the shell command conditionally
  - can use multiple dotbot configs to run different OS
    - Ex: incorporating it in https://github.com/ecarlson94/dotbot-template

  ## where
  - file changed in `./dotbot/plugins/shell.py`

  ## usage
  Create dotbot config
    ```yaml
    - shell:
        - command: echo "this is running on a MacOS"
          if: uname -s | grep -i "Darwin"
    ```

    ```yaml
    - shell:
        - command: echo "This command should be skipped"
          if: false
    ```
2022-08-11 21:10:50 -06:00
Anish Athalye
d2f76a2593 Merge branch 'kurtmckee/update-vm-os' 2022-04-11 08:05:50 -04:00
Anish Athalye
5f84611372 Merge branch 'kurtmckee/fix-vagrant-unauthenti...' 2022-04-11 08:04:45 -04:00
Kurt McKee
57c7c513b9 Update the Vagrantfile target OS to Ubuntu jammy
This resolves VirtualBox 5.x/6.x Guest Additions incompatibilities
that cause all of the unit tests to fail under VirtualBox 6.1.

Fixes #305
2022-04-10 22:24:19 -05:00
Kurt McKee
1931c9ac06 Update the unauthenticated git protocol to HTTPS
The unauthenticated git protocol is no longer supported.

https://github.blog/2021-09-01-improving-git-protocol-security-github/

Fixes #303
2022-04-10 21:11:07 -05:00
Anish Athalye
769767c129 Migrate code style to Black 2022-01-30 18:53:05 -05:00
Anish Athalye
ac5793ceb5 Merge branch 'dkm/patch-1' 2021-10-25 14:39:24 -04:00
Marc Poulhiès
b306a25e13
Update README.md
small typo fix
2021-10-25 20:19:41 +02:00
Anish Athalye
fb18c9b112 Merge branch 'ssbanerje/master' 2021-10-03 20:37:24 -04:00
Subho Banerjee
aaf5037725
better test case for exit-on-failure 2021-09-12 19:40:37 -05:00
Subho Banerjee
4d2e1537f4
adding a exit on failure flag 2021-09-12 19:34:44 -05:00
Anish Athalye
076939da8e Remove stray asterisk 2021-06-02 20:23:55 -04:00
Anish Athalye
24f88c4584 Merge branch 'eengstrom/259-link-prefix' 2021-06-02 20:21:40 -04:00
Anish Athalye
74822af9f5 Merge branch 'eengstrom/270-recursive-globbing' 2021-06-02 20:11:25 -04:00
Anish Athalye
67a3527f67 Merge branch 'eengstrom/280-fix-pyenv-config' 2021-06-02 19:48:19 -04:00
Eric Engstrom
cb6718ba87 test: fix pyenv configuration in vagrant
- addresses change in `pyenv init -` that no longer adjusts PATH.
- also updated testing README.md for readability.

FIXES: #280
2021-06-02 19:47:57 -04:00
Eric Engstrom
6c044208fa
feat: Add prefix: 'string' option to linking when glob: true.
Allows one to store files in a directory or git-repo without the leading 
`.`, as in:

```
dotconf:
├── README.md
├── bin
│   ├── dotbot
│   ├── look
│   ├── pbfile
│   └── ...
├── dot
│   ├── bashrc
│   ├── gitconfig
│   ├── gitignore
│   ├── gorc
│   ├── login
│   ├── ...
│   ├── zshrc
│   └── zshenv
```

Can take a many-line dotbot.yml listing **each** file in `dotconf/dot`,
reducing it to five lines:

```
- link:
    ~/:
      path: dotconf/dot/*
      glob: true
      prefix: '.'
```

FIXES: #259
2021-05-27 12:07:17 -05:00
Eric Engstrom
ab7cbd42dc
feat: Support recursive globbing with **.
For example, will handle an entire directory tree of files, linking all 
files:

```
- link:
    ~/.config/:
      path: dotconf/config/**
      glob: true
```

NOTE, this feature requires newer versions of `glob()` (Python >= 3.5),
and `dotbot` will throw an error if using an earlier version of python.

For testing purposes, added:
  - ability to skip tests in test harness
  - added testing for older Python(s).

FIXES: #270
2021-05-27 11:58:55 -05:00
Anish Athalye
aa9335089b Migrate changelog from wiki into source tree 2021-04-29 18:24:51 -04:00
Anish Athalye
e0cf5f993f Merge branch 'eengstrom/244-fix-link-glob-patterns' 2021-04-29 18:09:39 -04:00
Anish Athalye
289c724b1c Merge branch 'Justintime50/readme-being-typo' 2021-04-29 08:07:06 -04:00
Justintime50
84a836ea33 Fixes typos in README "being" to "begin" 2021-04-28 16:30:48 -06:00
Eric Engstrom
f56e903cee
Support both [] and ? glob patterns 2021-04-15 23:28:19 -05:00
Anish Athalye
dcb3743115 Release 1.19.0 2021-04-06 10:54:27 -04:00
Anish Athalye
0f5a5f3385 Update dates 2021-03-31 20:11:24 -04:00
Anish Athalye
472223300f Drop CI support for Python 3.4 and add Python 3.9 2021-03-13 06:22:58 -05:00
Anish Athalye
eb7f3fb7b1 Include git hash in version when available 2021-02-27 14:34:52 -05:00
Anish Athalye
5f849ad07f Merge branch 'sitiom/master' 2021-02-25 15:05:02 -05:00
sitiom
6de5cc6c2c Add PowerShell install script 2021-02-25 14:43:49 -05:00
Anish Athalye
f15293b3d5 Rename 'canonicalize-path' into 'canonicalize'
This parallels 'relative' (it's not 'relative-path'). The old
'canonicalize-path' is still supported for backward compatibility.
2021-02-25 08:26:19 -05:00
Anish Athalye
66489f7955 Fix missing endings of heredocs 2021-02-25 08:16:27 -05:00
Anish Athalye
dac7a9bc88 Add --debug flag to test driver
This is easier than the old method of adding `DEBUG=true` to the top of
test files.
2021-02-25 08:14:34 -05:00
Anish Athalye
43b62ed532 Merge branch 'etkeys/feature/cli-force-shell-out-err-true' 2021-02-25 08:02:13 -05:00
E. Keys
c35382c06d Add cli option force shell show stderr/stdout
Passing `--verbose` flag two times will now force shell commands to show
stderr/stdout output regardless of settings in config file.

Resolves #104
2021-02-25 08:00:07 -05:00
Anish Athalye
5f1e33ed67 Merge branch 'etkeys/feature/expose-cli-options-for-plugins' 2021-02-25 07:57:19 -05:00
E. Keys
b18ba4d392 Make parsed CLI options available to plugins 2021-02-25 07:57:12 -05:00
Anish Athalye
22ed23c7d9 Merge branch 'etkeys/feature/glob-with-exclude' 2021-02-25 06:59:22 -05:00
Anish Athalye
de8793de99 Merge branch 'etkeys/bugfix/fix-glob-dropping-leading-dot' 2021-02-25 06:44:32 -05:00
E. Keys
6c6fee697e Improve globbing behavior with leading '.' 2021-02-25 06:44:14 -05:00
Anish Athalye
945c1e5a4e Add mode option to create directive
See <https://github.com/anishathalye/dotbot/issues/260>. Thanks to
@eengstrom for the feature suggestion.
2021-02-25 06:25:17 -05:00
Anish Athalye
4ec846cdad Make tests run on pull requests 2020-12-26 05:01:29 -05:00
Anish Athalye
d55e2af83a Add direct link to tutorials page in the wiki 2020-12-23 18:26:56 -05:00
Anish Athalye
be539e6e24 Remove packaging information from README
This content was not relevant to anyone but the owner of the PyPI
package.
2020-12-23 18:08:48 -05:00
Anish Athalye
a5e1dca91d Release 1.18.0 2020-12-23 18:04:23 -05:00
Anish Athalye
d7629553bd Switch to GitHub Actions 2020-12-18 15:34:15 -05:00
Anish Athalye
cf366bbf66 Fix interaction between --only and defaults
We should treat defaults specially, and even when `--only` is
specified, we should always run defaults.
2020-11-22 16:58:00 -05:00
E. Keys
2ec7a24129 Add exclude parameter for link globbing
- Added `exclude` parameter to _link_. Now, an array of glob patterns
    can be given that will be used to remove items from a glob match.
    This parameter will only have an effect when `glob` is `true`.
- Updated README to add description for `exclude` and add in examples.

Resolves #247
2020-11-22 14:13:11 -05:00
Anish Athalye
5294594f5a Merge branch 'bobwhitelock/add-force-color-option' into master 2020-08-23 09:16:58 -04:00
Bob Whitelock
2432a2ba87 Add --force-color option
This forces Dotbot to produce colored output, regardless of whether it
is outputting to a TTY.

This is useful to support use cases such as piping colored Dotbot output
into another program for formatting (e.g. I want to indent the output as
part of a larger installation script); this was not previously easy to
do as this would cause the output to lose its colored formatting.

This option cannot be provided at the same time as the existing
`--no-color` option, as there's no logical interpretation of what effect
providing both of these should have.

As part of this change I've refactored some existing code determining
whether output should be colored to where options are parsed, as this
made this change simpler and I think it makes sense for all this logic
to be performed in the same place.
2020-08-23 00:02:26 +01:00