Skip to content

Commit cd2f469

Browse files
authored
Update README.md (#81)
* Update README.md * Update README.md * Update appveyor.yml
1 parent 4960a81 commit cd2f469

File tree

2 files changed

+11
-5
lines changed

2 files changed

+11
-5
lines changed

README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ myke solves all these problems in a single tiny binary, to avoid reinventing the
99
## Features
1010

1111
* Define tasks in simple `.yml` files
12+
* Tasks execute in a predictable environment irrespective of which folder they are invoked from
1213
* Nice aggregation and discovery with tag-based grouping, suitable for few and many tasks, organizing into subfolders/submodules/repos/projects
1314
* Robust environment handling - Can be defined as keys in the YML or as dotenv files, overridden by dotenv.local files, `PATH` is always prepended, shell always takes precedence
1415
* Built-in templating using golang text/template and 50+ functions provided by [sprig](https://github.com/Masterminds/sprig)
@@ -54,20 +55,20 @@ Explore the self documenting `examples` folder.
5455

5556
## Task Execution Environment
5657

57-
* `cwd` is set to the YML file base folder
58-
* `cwd/bin` is added to `PATH`
58+
* tasks always run with `cwd` set to the folder where the task is defined
59+
* `cwd/bin` is always added to `PATH`
5960
* environment variables are loaded from:
6061
* `env` property in yml
6162
* dotenv files from `env_files`
62-
* for every dotenv file, the corresponding dotenv `.local` file is also loaded
63+
* for every dotenv file, the corresponding dotenv `.local` file is also loaded if present
6364
* same is done for every mixin that the yml uses
6465
* So, if you mixin `<some-other-folder>/myke.yml`, then that yml's `cwd/bin` is also added to the PATH, that yml's env/env_files/env_files.local are also loaded, and so on
6566
* shell exported environment variables take precedence
66-
* additional variables: `$MYKE_PROJECT`, `$MYKE_TASK`, `$MYKE_CWD`
67+
* additional variables: `$MYKE_PROJECT`, `$MYKE_TASK`, `$MYKE_CWD` are always set
6768
* `$myke` is set to full path of myke itself to easily nest myke calls (e.g. `$myke do_something` will become `myke.exe do_something` in windows)
6869
* command is templated using golang text/template and sprig
6970
* environment and task arguments are passed in as variables
70-
* command is run using `sh -exc`
71+
* command is run using `sh -exc` in Linux/OSX, and `cmd.exe /C` in Windows
7172

7273
## FAQs
7374

appveyor.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,11 @@ version: "{build}"
22
os: Windows Server 2012 R2
33
clone_folder: c:\gopath\src\github.com\goeuro\myke
44

5+
skip_tags: true
6+
branches:
7+
only:
8+
- master
9+
510
environment:
611
GOPATH: C:\gopath
712
matrix:

0 commit comments

Comments
 (0)