Deceive Ansible to template Trellis .env files to local Bedrock
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bin
src
templates
.editorconfig
.gitignore
.node-version
CHANGELOG.md
LICENSE
README.md
package.json
tsconfig.json
tslint.json
yarn.lock

README.md

enveigle

Deceive Ansible to template Trellis .env files to local Bedrock

oclif Version Downloads/week License Hire Itineris

Goal

Populate .env files to local Bedrock with ansible so that we can develop with valet instead of vagrant while keeping ansible vault, wordpress_env_defaults and all ansible goodies.

Requirements

  • Trellis
  • Bedrock
  • Anisble v2 or later
  • NodeJS v10.13.0 or later

Installation

$ npx @itinerisltd/enveigle just work! No installation required.

Usage

$ cd /path/to/trellis

# For normal Trellis setup
$ npx @itinerisltd/enveigle

# For brave developers
$ npx @itinerisltd/enveigle --env=my-custom-dev-env --callback_dir=callback_dir=/path/to/my/callback/dir

# For the confused
$ npx @itinerisltd/enveigle --help
Deceive Ansible to template Trellis .env files to local Bedrock

USAGE
  $ npx @itinerisltd/enveigle

OPTIONS
  -c, --callback_dir=callback_dir  [default: lib/trellis/plugins/callback] ansible callback directory
  -e, --env=env                    [default: development] local environment name
  -h, --help                       show CLI help
  -v, --version                    show CLI version

FAQ

Can I change default flag values?

Yes. You can change them via environment variables.

These 2 commands are equivalent:

$ ENVEIGLE_ENV=my-env ENVEIGLE_CALLBACK_DIR=/my/callback/dir npx @itinerisltd/enveigle
$ npx @itinerisltd/enveigle --env=my-env --callback_dir=callback_dir=/my/callback/dir

Can I install enveigle instead of using $ npx?

Yes. However, you are responsible for updating it.

# yarn or npm doesn't matter
$ yarn global add @itinerisltd/enveigle
$ cd /path/to/trellis
$ enveigle

Why not commit enveigle.yml under git?

Because we have too many sites to maintain, adding/updating enveigle.yml to all of our sites is tedious.

It looks awesome. Where can I find some more goodies like this?

This isn't on wp.org. Where can I give a ⭐️⭐️⭐️⭐️⭐️ review?

Thanks! Glad you like it. It's important to make my boss know somebody is using this project. Instead of giving reviews on wp.org, consider:

Feedback

Please provide feedback! We want to make this library useful in as many projects as possible. Please submit an issue and point out what you do and don't like, or fork the project and make suggestions. No issue is too small.

Security

If you discover any security related issues, please email hello@itineris.co.uk instead of using the issue tracker.

Change log

Please see CHANGELOG for more information on what has changed recently.

Credits

enveigle is a Itineris Limited project created by Tang Rufus.

Full list of contributors can be found here.

License

enveigle is released under the MIT License.