Skip to content

Commit 8550034

Browse files
Chris Everyosterman
Chris Every
andauthored
Add -no-color flag to readme cmds (#18)
* Add -no-color flag to readme cmds * Generated README.md from build_harness Co-authored-by: Erik Osterman <erik@cloudposse.com>
1 parent cc54476 commit 8550034

File tree

2 files changed

+100
-47
lines changed

2 files changed

+100
-47
lines changed

README.md

Lines changed: 97 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,43 @@
1-
<!-- This file was automatically generated by the `build-harness`. Make all changes to `README.yaml` and run `make readme` to rebuild this file. -->
1+
<!--
2+
3+
4+
5+
6+
7+
8+
9+
10+
11+
12+
13+
14+
15+
16+
** DO NOT EDIT THIS FILE
17+
**
18+
** This file was automatically generated by the `build-harness`.
19+
** 1) Make all changes to `README.yaml`
20+
** 2) Run `make init` (you only need to do this once)
21+
** 3) Run`make readme` to rebuild this file.
22+
**
23+
** (We maintain HUNDREDS of open source projects. This is how we maintain our sanity.)
24+
**
25+
26+
27+
28+
29+
30+
31+
32+
33+
34+
35+
36+
37+
38+
39+
40+
-->
241
[![README Header][readme_header_img]][readme_header_link]
342

443
[![Cloud Posse][logo]](https://cpco.io/homepage)
@@ -60,6 +99,8 @@ __NOTE__: `tfmask` will preserve the name of the nodes in the graph
6099
## Usage
61100

62101

102+
103+
63104
__NOTE__: The utility supports a number of configuration settings which can be passed via environment variables.
64105

65106
| Environment Variable | Description | Default |
@@ -73,7 +114,7 @@ __IMPORTANT__: Pass `-no-color` to `terraform plan` and `terraform apply` for pr
73114
The basic usage looks like this. We're going to run `terraform plan` and filter it through `tfmask`:
74115

75116
```sh
76-
terraform plan | tfmask
117+
terraform plan -no-color | tfmask
77118
```
78119

79120
### Direnv
@@ -85,7 +126,7 @@ Example `.envrc`:
85126
```sh
86127
# Export terraform environment
87128
export TFMASK_CHAR="#"
88-
export TFMASK_VALUES_REGEX="(?i)^.*(secret|password|oauth|token|key).*$"
129+
export TFMASK_VALUES_REGEX="(?i)^.*(oauth|secret|token|password|key|result).*$"
89130
```
90131

91132
<details>
@@ -140,7 +181,7 @@ make go/build
140181
Using `tfmask`, the output from `terraform plan` will be masked like this:
141182

142183
```sh
143-
terraform plan | tfmask
184+
terraform plan -no-color | tfmask
144185
```
145186

146187
<details>
@@ -183,7 +224,7 @@ Many terraform providers unintentionally leak sensitive information when running
183224
Using `tfmask`, the output from `terraform apply` will be masked like this:
184225

185226
```sh
186-
terraform apply | tfmask
227+
terraform apply -no-color | tfmask
187228
```
188229
<details>
189230
<summary>Example of Masked Terraform Apply Output</summary>
@@ -223,38 +264,51 @@ Check out these related projects.
223264

224265
## Help
225266

226-
**Got a question?**
267+
**Got a question?** We got answers.
227268

228269
File a GitHub [issue](https://github.com/cloudposse/tfmask/issues), send us an [email][email] or join our [Slack Community][slack].
229270

230271
[![README Commercial Support][readme_commercial_support_img]][readme_commercial_support_link]
231272

232-
## Commercial Support
233-
234-
Work directly with our team of DevOps experts via email, slack, and video conferencing.
273+
## DevOps Accelerator for Startups
235274

236-
We provide [*commercial support*][commercial_support] for all of our [Open Source][github] projects. As a *Dedicated Support* customer, you have access to our team of subject matter experts at a fraction of the cost of a full-time engineer.
237275

238-
[![E-Mail](https://img.shields.io/badge/email-hello@cloudposse.com-blue.svg)][email]
276+
We are a [**DevOps Accelerator**][commercial_support]. We'll help you build your cloud infrastructure from the ground up so you can own it. Then we'll show you how to operate it and stick around for as long as you need us.
239277

240-
- **Questions.** We'll use a Shared Slack channel between your team and ours.
241-
- **Troubleshooting.** We'll help you triage why things aren't working.
242-
- **Code Reviews.** We'll review your Pull Requests and provide constructive feedback.
243-
- **Bug Fixes.** We'll rapidly work to fix any bugs in our projects.
244-
- **Build New Terraform Modules.** We'll [develop original modules][module_development] to provision infrastructure.
245-
- **Cloud Architecture.** We'll assist with your cloud strategy and design.
246-
- **Implementation.** We'll provide hands-on support to implement our reference architectures.
278+
[![Learn More](https://img.shields.io/badge/learn%20more-success.svg?style=for-the-badge)][commercial_support]
247279

280+
Work directly with our team of DevOps experts via email, slack, and video conferencing.
248281

282+
We deliver 10x the value for a fraction of the cost of a full-time engineer. Our track record is not even funny. If you want things done right and you need it done FAST, then we're your best bet.
249283

284+
- **Reference Architecture.** You'll get everything you need from the ground up built using 100% infrastructure as code.
285+
- **Release Engineering.** You'll have end-to-end CI/CD with unlimited staging environments.
286+
- **Site Reliability Engineering.** You'll have total visibility into your apps and microservices.
287+
- **Security Baseline.** You'll have built-in governance with accountability and audit logs for all changes.
288+
- **GitOps.** You'll be able to operate your infrastructure via Pull Requests.
289+
- **Training.** You'll receive hands-on training so your team can operate what we build.
290+
- **Questions.** You'll have a direct line of communication between our teams via a Shared Slack channel.
291+
- **Troubleshooting.** You'll get help to triage when things aren't working.
292+
- **Code Reviews.** You'll receive constructive feedback on Pull Requests.
293+
- **Bug Fixes.** We'll rapidly work with you to fix any bugs in our projects.
250294

251295
## Slack Community
252296

253297
Join our [Open Source Community][slack] on Slack. It's **FREE** for everyone! Our "SweetOps" community is where you get to talk with others who share a similar vision for how to rollout and manage infrastructure. This is the best place to talk shop, ask questions, solicit feedback, and work together as a community to build totally *sweet* infrastructure.
254298

299+
## Discourse Forums
300+
301+
Participate in our [Discourse Forums][discourse]. Here you'll find answers to commonly asked questions. Most questions will be related to the enormous number of projects we support on our GitHub. Come here to collaborate on answers, find solutions, and get ideas about the products and services we value. It only takes a minute to get started! Just sign in with SSO using your GitHub account.
302+
255303
## Newsletter
256304

257-
Signup for [our newsletter][newsletter] that covers everything on our technology radar. Receive updates on what we're up to on GitHub as well as awesome new projects we discover.
305+
Sign up for [our newsletter][newsletter] that covers everything on our technology radar. Receive updates on what we're up to on GitHub as well as awesome new projects we discover.
306+
307+
## Office Hours
308+
309+
[Join us every Wednesday via Zoom][office_hours] for our weekly "Lunch & Learn" sessions. It's **FREE** for everyone!
310+
311+
[![zoom](https://img.cloudposse.com/fit-in/200x200/https://cloudposse.com/wp-content/uploads/2019/08/Powered-by-Zoom.png")][office_hours]
258312

259313
## Contributing
260314

@@ -279,7 +333,7 @@ In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.
279333

280334
## Copyright
281335

282-
Copyright © 2017-2019 [Cloud Posse, LLC](https://cpco.io/copyright)
336+
Copyright © 2017-2020 [Cloud Posse, LLC](https://cpco.io/copyright)
283337

284338

285339

@@ -339,35 +393,34 @@ Check out [our other projects][github], [follow us on twitter][twitter], [apply
339393

340394

341395
[osterman_homepage]: https://github.com/osterman
342-
[osterman_avatar]: https://github.com/osterman.png?size=150
343-
344-
396+
[osterman_avatar]: https://img.cloudposse.com/150x150/https://github.com/osterman.png
345397

346398
[![README Footer][readme_footer_img]][readme_footer_link]
347399
[![Beacon][beacon]][website]
348400

349401
[logo]: https://cloudposse.com/logo-300x69.svg
350-
[docs]: https://cpco.io/docs
351-
[website]: https://cpco.io/homepage
352-
[github]: https://cpco.io/github
353-
[jobs]: https://cpco.io/jobs
354-
[hire]: https://cpco.io/hire
355-
[slack]: https://cpco.io/slack
356-
[linkedin]: https://cpco.io/linkedin
357-
[twitter]: https://cpco.io/twitter
358-
[testimonial]: https://cpco.io/leave-testimonial
359-
[newsletter]: https://cpco.io/newsletter
360-
[email]: https://cpco.io/email
361-
[commercial_support]: https://cpco.io/commercial-support
362-
[we_love_open_source]: https://cpco.io/we-love-open-source
363-
[module_development]: https://cpco.io/module-development
364-
[terraform_modules]: https://cpco.io/terraform-modules
365-
[readme_header_img]: https://cloudposse.com/readme/header/img?repo=cloudposse/tfmask
366-
[readme_header_link]: https://cloudposse.com/readme/header/link?repo=cloudposse/tfmask
367-
[readme_footer_img]: https://cloudposse.com/readme/footer/img?repo=cloudposse/tfmask
368-
[readme_footer_link]: https://cloudposse.com/readme/footer/link?repo=cloudposse/tfmask
369-
[readme_commercial_support_img]: https://cloudposse.com/readme/commercial-support/img?repo=cloudposse/tfmask
370-
[readme_commercial_support_link]: https://cloudposse.com/readme/commercial-support/link?repo=cloudposse/tfmask
402+
[docs]: https://cpco.io/docs?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/tfmask&utm_content=docs
403+
[website]: https://cpco.io/homepage?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/tfmask&utm_content=website
404+
[github]: https://cpco.io/github?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/tfmask&utm_content=github
405+
[jobs]: https://cpco.io/jobs?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/tfmask&utm_content=jobs
406+
[hire]: https://cpco.io/hire?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/tfmask&utm_content=hire
407+
[slack]: https://cpco.io/slack?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/tfmask&utm_content=slack
408+
[linkedin]: https://cpco.io/linkedin?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/tfmask&utm_content=linkedin
409+
[twitter]: https://cpco.io/twitter?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/tfmask&utm_content=twitter
410+
[testimonial]: https://cpco.io/leave-testimonial?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/tfmask&utm_content=testimonial
411+
[office_hours]: https://cloudposse.com/office-hours?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/tfmask&utm_content=office_hours
412+
[newsletter]: https://cpco.io/newsletter?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/tfmask&utm_content=newsletter
413+
[discourse]: https://ask.sweetops.com/?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/tfmask&utm_content=discourse
414+
[email]: https://cpco.io/email?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/tfmask&utm_content=email
415+
[commercial_support]: https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/tfmask&utm_content=commercial_support
416+
[we_love_open_source]: https://cpco.io/we-love-open-source?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/tfmask&utm_content=we_love_open_source
417+
[terraform_modules]: https://cpco.io/terraform-modules?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/tfmask&utm_content=terraform_modules
418+
[readme_header_img]: https://cloudposse.com/readme/header/img
419+
[readme_header_link]: https://cloudposse.com/readme/header/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/tfmask&utm_content=readme_header_link
420+
[readme_footer_img]: https://cloudposse.com/readme/footer/img
421+
[readme_footer_link]: https://cloudposse.com/readme/footer/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/tfmask&utm_content=readme_footer_link
422+
[readme_commercial_support_img]: https://cloudposse.com/readme/commercial-support/img
423+
[readme_commercial_support_link]: https://cloudposse.com/readme/commercial-support/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/tfmask&utm_content=readme_commercial_support_link
371424
[share_twitter]: https://twitter.com/intent/tweet/?text=tfmask&url=https://github.com/cloudposse/tfmask
372425
[share_linkedin]: https://www.linkedin.com/shareArticle?mini=true&title=tfmask&url=https://github.com/cloudposse/tfmask
373426
[share_reddit]: https://reddit.com/submit/?url=https://github.com/cloudposse/tfmask

README.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ usage: |-
7171
The basic usage looks like this. We're going to run `terraform plan` and filter it through `tfmask`:
7272
7373
```sh
74-
terraform plan | tfmask
74+
terraform plan -no-color | tfmask
7575
```
7676
7777
### Direnv
@@ -152,7 +152,7 @@ examples: |-
152152
Using `tfmask`, the output from `terraform plan` will be masked like this:
153153
154154
```sh
155-
terraform plan | tfmask
155+
terraform plan -no-color | tfmask
156156
```
157157
158158
<details>
@@ -195,7 +195,7 @@ examples: |-
195195
Using `tfmask`, the output from `terraform apply` will be masked like this:
196196
197197
```sh
198-
terraform apply | tfmask
198+
terraform apply -no-color | tfmask
199199
```
200200
<details>
201201
<summary>Example of Masked Terraform Apply Output</summary>

0 commit comments

Comments
 (0)