Skip to content

Commit 7801844

Browse files
authored
Update README.md and docs
1 parent 6008b2a commit 7801844

2 files changed

Lines changed: 76 additions & 131 deletions

File tree

README.md

Lines changed: 74 additions & 131 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,10 @@
11

22
<!-- markdownlint-disable -->
3-
# kubernetes-namespace-builder-composite-action
3+
# kubernetes-namespace-builder-composite-action<a href="https://cpco.io/homepage"><img align="right" src="https://cloudposse.com/logo-300x69.svg" width="150" /></a>
44

55
[![Latest Release](https://img.shields.io/github/release/cloudposse/kubernetes-namespace-builder-composite-action.svg)](https://github.com/cloudposse/kubernetes-namespace-builder-composite-action/releases/latest) [![Slack Community](https://slack.cloudposse.com/badge.svg)](https://slack.cloudposse.com)
66
<!-- markdownlint-restore -->
77

8-
[![README Header][readme_header_img]][readme_header_link]
9-
10-
[![Cloud Posse][logo]](https://cpco.io/homepage)
118

129
<!--
1310
@@ -32,30 +29,15 @@
3229

3330
Generate Kubernetes namespace for a preview environment
3431

35-
---
36-
37-
This project is part of our comprehensive ["SweetOps"](https://cpco.io/sweetops) approach towards DevOps.
38-
[<img align="right" title="Share via Email" src="https://docs.cloudposse.com/images/ionicons/ios-email-outline-2.0.1-16x16-999999.svg"/>][share_email]
39-
[<img align="right" title="Share on Google+" src="https://docs.cloudposse.com/images/ionicons/social-googleplus-outline-2.0.1-16x16-999999.svg" />][share_googleplus]
40-
[<img align="right" title="Share on Facebook" src="https://docs.cloudposse.com/images/ionicons/social-facebook-outline-2.0.1-16x16-999999.svg" />][share_facebook]
41-
[<img align="right" title="Share on Reddit" src="https://docs.cloudposse.com/images/ionicons/social-reddit-outline-2.0.1-16x16-999999.svg" />][share_reddit]
42-
[<img align="right" title="Share on LinkedIn" src="https://docs.cloudposse.com/images/ionicons/social-linkedin-outline-2.0.1-16x16-999999.svg" />][share_linkedin]
43-
[<img align="right" title="Share on Twitter" src="https://docs.cloudposse.com/images/ionicons/social-twitter-outline-2.0.1-16x16-999999.svg" />][share_twitter]
44-
45-
46-
47-
48-
It's 100% Open Source and licensed under the [APACHE2](LICENSE).
49-
50-
51-
52-
53-
54-
55-
56-
5732

33+
---
34+
> [!NOTE]
35+
> This project is part of Cloud Posse's comprehensive ["SweetOps"](https://cpco.io/sweetops) approach towards DevOps.
36+
>
37+
> It's 100% Open Source and licensed under the [APACHE2](LICENSE).
38+
>
5839
40+
[![README Header][readme_header_img]][readme_header_link]
5941

6042

6143
## Introduction
@@ -67,8 +49,6 @@ This composite action builds a kubernetes namespace based on inputs. It currentl
6749

6850

6951

70-
71-
7252
## Usage
7353

7454

@@ -87,14 +67,35 @@ Please see [workflows dir](https://github.com/cloudposse/kubernetes-namespace-bu
8767
context:
8868
runs-on: ubuntu-latest
8969
steps:
90-
- name: Example action
70+
- name: Example PR Number
9171
uses: cloudposse/kubernetes-namespace-builder-composite-action@main
9272
id: kubernetes-namespace
9373
with:
9474
flavor: pr-number
9575
app-name: my-app
96-
# prefix: prefix
97-
# suffix: suffix
76+
# prefix: prefix
77+
# suffix: suffix
78+
deny-list: kube-system,kube-public,default
79+
80+
- name: Example Branch Name
81+
uses: cloudposse/kubernetes-namespace-builder-composite-action@main
82+
id: branch-name
83+
with:
84+
flavor: branch-name
85+
app-name: app
86+
# prefix: cp
87+
# suffix: suffix
88+
deny-list: kube-system,kube-public,default
89+
90+
- name: Example Custom Naming convention
91+
uses: cloudposse/kubernetes-namespace-builder-composite-action@main
92+
id: custom-name
93+
with:
94+
flavor: custom
95+
name: my-custom-name
96+
app-name: app
97+
# prefix: cp
98+
# suffix: suffix
9899
deny-list: kube-system,kube-public,default
99100

100101
outputs:
@@ -115,6 +116,8 @@ Please see [workflows dir](https://github.com/cloudposse/kubernetes-namespace-bu
115116
|------|-------------|---------|----------|
116117
| app-name | Name of the application | | false |
117118
| deny-list | Comma seperated list of strings to deny in the namespace name | kube-system,kube-public,default | false |
119+
| enabled | Whether or not to run this action, empty string or false is false, anything else is true | true | false |
120+
| fallback | Fallback value if the action is disabled | | false |
118121
| flavor | Flavor of naming, either `pr-number`, `branch-name`, or `custom`. Note `name` must be set if using `custom` | pr-number | false |
119122
| name | name for namespace if using flavor `custom`, still prefixed | | true |
120123
| override-branch-name | Override the branch name, useful for manually helping calculate the branch name | N/A | false |
@@ -131,15 +134,6 @@ Please see [workflows dir](https://github.com/cloudposse/kubernetes-namespace-bu
131134
<!-- markdownlint-restore -->
132135

133136

134-
135-
## Share the Love
136-
137-
Like this project? Please give it a ★ on [our GitHub](https://github.com/cloudposse/kubernetes-namespace-builder-composite-action)! (it helps us **a lot**)
138-
139-
Are you using this project or any of our other projects? Consider [leaving a testimonial][testimonial]. =)
140-
141-
142-
143137
## Related Projects
144138

145139
Check out these related projects.
@@ -154,81 +148,70 @@ For additional context, refer to some of these links.
154148
- [example-github-action-release-workflow](https://github.com/cloudposse/example-github-action-release-workflow) - Example application with complicated release workflow
155149

156150

157-
## Help
158-
159-
**Got a question?** We got answers.
151+
## ✨ Contributing
160152

161-
File a GitHub [issue](https://github.com/cloudposse/kubernetes-namespace-builder-composite-action/issues), send us an [email][email] or join our [Slack Community][slack].
153+
This project is under active development, and we encourage contributions from our community.
154+
Many thanks to our outstanding contributors:
162155

163-
[![README Commercial Support][readme_commercial_support_img]][readme_commercial_support_link]
156+
<a href="https://github.com/cloudposse/kubernetes-namespace-builder-composite-action/graphs/contributors">
157+
<img src="https://contrib.rocks/image?repo=cloudposse/kubernetes-namespace-builder-composite-action&max=24" />
158+
</a>
164159

165-
## DevOps Accelerator for Startups
160+
### 🐛 Bug Reports & Feature Requests
166161

162+
Please use the [issue tracker](https://github.com/cloudposse/kubernetes-namespace-builder-composite-action/issues) to report any bugs or file feature requests.
167163

168-
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.
164+
### 💻 Developing
169165

170-
[![Learn More](https://img.shields.io/badge/learn%20more-success.svg?style=for-the-badge)][commercial_support]
166+
If you are interested in being a contributor and want to get involved in developing this project or [help out](https://cpco.io/help-out) with Cloud Posse's other projects, we would love to hear from you! Shoot us an [email][email].
171167

172-
Work directly with our team of DevOps experts via email, slack, and video conferencing.
168+
In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.
173169

174-
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.
170+
1. **Fork** the repo on GitHub
171+
2. **Clone** the project to your own machine
172+
3. **Commit** changes to your own branch
173+
4. **Push** your work back up to your fork
174+
5. Submit a **Pull Request** so that we can review your changes
175175

176-
- **Reference Architecture.** You'll get everything you need from the ground up built using 100% infrastructure as code.
177-
- **Release Engineering.** You'll have end-to-end CI/CD with unlimited staging environments.
178-
- **Site Reliability Engineering.** You'll have total visibility into your apps and microservices.
179-
- **Security Baseline.** You'll have built-in governance with accountability and audit logs for all changes.
180-
- **GitOps.** You'll be able to operate your infrastructure via Pull Requests.
181-
- **Training.** You'll receive hands-on training so your team can operate what we build.
182-
- **Questions.** You'll have a direct line of communication between our teams via a Shared Slack channel.
183-
- **Troubleshooting.** You'll get help to triage when things aren't working.
184-
- **Code Reviews.** You'll receive constructive feedback on Pull Requests.
185-
- **Bug Fixes.** We'll rapidly work with you to fix any bugs in our projects.
176+
**NOTE:** Be sure to merge the latest changes from "upstream" before making a pull request!
186177

187-
## Slack Community
178+
### 🌎 Slack Community
188179

189180
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.
190181

191-
## Discourse Forums
192-
193-
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.
194-
195-
## Newsletter
182+
### 📰 Newsletter
196183

197184
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.
198185

199-
## Office Hours
186+
### 📆 Office Hours <img src="https://img.cloudposse.com/fit-in/200x200/https://cloudposse.com/wp-content/uploads/2019/08/Powered-by-Zoom.png" align="right" />
200187

201188
[Join us every Wednesday via Zoom][office_hours] for our weekly "Lunch & Learn" sessions. It's **FREE** for everyone!
202189

203-
[![zoom](https://img.cloudposse.com/fit-in/200x200/https://cloudposse.com/wp-content/uploads/2019/08/Powered-by-Zoom.png")][office_hours]
204-
205-
## Contributing
206-
207-
### Bug Reports & Feature Requests
208-
209-
Please use the [issue tracker](https://github.com/cloudposse/kubernetes-namespace-builder-composite-action/issues) to report any bugs or file feature requests.
210-
211-
### Developing
212-
213-
If you are interested in being a contributor and want to get involved in developing this project or [help out](https://cpco.io/help-out) with our other projects, we would love to hear from you! Shoot us an [email][email].
214-
215-
In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.
216-
217-
1. **Fork** the repo on GitHub
218-
2. **Clone** the project to your own machine
219-
3. **Commit** changes to your own branch
220-
4. **Push** your work back up to your fork
221-
5. Submit a **Pull Request** so that we can review your changes
190+
## About
222191

223-
**NOTE:** Be sure to merge the latest changes from "upstream" before making a pull request!
192+
This project is maintained and funded by [Cloud Posse, LLC][website].
193+
<a href="https://cpco.io/homepage"><img src="https://cloudposse.com/logo-300x69.svg" align="right" /></a>
224194

195+
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.
225196

226-
## Copyright
197+
[![Learn More](https://img.shields.io/badge/learn%20more-success.svg?style=for-the-badge)][commercial_support]
227198

228-
Copyright © 2017-2023 [Cloud Posse, LLC](https://cpco.io/copyright)
199+
Work directly with our team of DevOps experts via email, slack, and video conferencing.
229200

201+
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.
230202

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

214+
[![README Commercial Support][readme_commercial_support_img]][readme_commercial_support_link]
232215
## License
233216

234217
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
@@ -254,42 +237,11 @@ specific language governing permissions and limitations
254237
under the License.
255238
```
256239

257-
258-
259-
260-
261-
262-
263-
264-
265240
## Trademarks
266241

267242
All other trademarks referenced herein are the property of their respective owners.
268-
269-
## About
270-
271-
This project is maintained and funded by [Cloud Posse, LLC][website]. Like it? Please let us know by [leaving a testimonial][testimonial]!
272-
273-
[![Cloud Posse][logo]][website]
274-
275-
We're a [DevOps Professional Services][hire] company based in Los Angeles, CA. We ❤️ [Open Source Software][we_love_open_source].
276-
277-
We offer [paid support][commercial_support] on all of our projects.
278-
279-
Check out [our other projects][github], [follow us on twitter][twitter], [apply for a job][jobs], or [hire us][hire] to help with your cloud strategy and implementation.
280-
281-
282-
283-
### Contributors
284-
285-
<!-- markdownlint-disable -->
286-
| [![Benjamin Smith][benbentwo_avatar]][benbentwo_homepage]<br/>[Benjamin Smith][benbentwo_homepage] |
287-
|---|
288-
<!-- markdownlint-restore -->
289-
290-
[benbentwo_homepage]: https://github.com/benbentwo
291-
[benbentwo_avatar]: https://img.cloudposse.com/150x150/https://github.com/benbentwo.png
292-
243+
---
244+
Copyright © 2017-2024 [Cloud Posse, LLC](https://cpco.io/copyright)
293245
[![README Footer][readme_footer_img]][readme_footer_link]
294246
[![Beacon][beacon]][website]
295247
<!-- markdownlint-disable -->
@@ -300,12 +252,9 @@ Check out [our other projects][github], [follow us on twitter][twitter], [apply
300252
[jobs]: https://cpco.io/jobs?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/kubernetes-namespace-builder-composite-action&utm_content=jobs
301253
[hire]: https://cpco.io/hire?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/kubernetes-namespace-builder-composite-action&utm_content=hire
302254
[slack]: https://cpco.io/slack?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/kubernetes-namespace-builder-composite-action&utm_content=slack
303-
[linkedin]: https://cpco.io/linkedin?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/kubernetes-namespace-builder-composite-action&utm_content=linkedin
304255
[twitter]: https://cpco.io/twitter?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/kubernetes-namespace-builder-composite-action&utm_content=twitter
305-
[testimonial]: https://cpco.io/leave-testimonial?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/kubernetes-namespace-builder-composite-action&utm_content=testimonial
306256
[office_hours]: https://cloudposse.com/office-hours?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/kubernetes-namespace-builder-composite-action&utm_content=office_hours
307257
[newsletter]: https://cpco.io/newsletter?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/kubernetes-namespace-builder-composite-action&utm_content=newsletter
308-
[discourse]: https://ask.sweetops.com/?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/kubernetes-namespace-builder-composite-action&utm_content=discourse
309258
[email]: https://cpco.io/email?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/kubernetes-namespace-builder-composite-action&utm_content=email
310259
[commercial_support]: https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/kubernetes-namespace-builder-composite-action&utm_content=commercial_support
311260
[we_love_open_source]: https://cpco.io/we-love-open-source?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/kubernetes-namespace-builder-composite-action&utm_content=we_love_open_source
@@ -316,11 +265,5 @@ Check out [our other projects][github], [follow us on twitter][twitter], [apply
316265
[readme_footer_link]: https://cloudposse.com/readme/footer/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/kubernetes-namespace-builder-composite-action&utm_content=readme_footer_link
317266
[readme_commercial_support_img]: https://cloudposse.com/readme/commercial-support/img
318267
[readme_commercial_support_link]: https://cloudposse.com/readme/commercial-support/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/kubernetes-namespace-builder-composite-action&utm_content=readme_commercial_support_link
319-
[share_twitter]: https://twitter.com/intent/tweet/?text=kubernetes-namespace-builder-composite-action&url=https://github.com/cloudposse/kubernetes-namespace-builder-composite-action
320-
[share_linkedin]: https://www.linkedin.com/shareArticle?mini=true&title=kubernetes-namespace-builder-composite-action&url=https://github.com/cloudposse/kubernetes-namespace-builder-composite-action
321-
[share_reddit]: https://reddit.com/submit/?url=https://github.com/cloudposse/kubernetes-namespace-builder-composite-action
322-
[share_facebook]: https://facebook.com/sharer/sharer.php?u=https://github.com/cloudposse/kubernetes-namespace-builder-composite-action
323-
[share_googleplus]: https://plus.google.com/share?url=https://github.com/cloudposse/kubernetes-namespace-builder-composite-action
324-
[share_email]: mailto:?subject=kubernetes-namespace-builder-composite-action&body=https://github.com/cloudposse/kubernetes-namespace-builder-composite-action
325268
[beacon]: https://ga-beacon.cloudposse.com/UA-76589703-4/cloudposse/kubernetes-namespace-builder-composite-action?pixel&cs=github&cm=readme&an=kubernetes-namespace-builder-composite-action
326269
<!-- markdownlint-restore -->

docs/github-action.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@
66
|------|-------------|---------|----------|
77
| app-name | Name of the application | | false |
88
| deny-list | Comma seperated list of strings to deny in the namespace name | kube-system,kube-public,default | false |
9+
| enabled | Whether or not to run this action, empty string or false is false, anything else is true | true | false |
10+
| fallback | Fallback value if the action is disabled | | false |
911
| flavor | Flavor of naming, either `pr-number`, `branch-name`, or `custom`. Note `name` must be set if using `custom` | pr-number | false |
1012
| name | name for namespace if using flavor `custom`, still prefixed | | true |
1113
| override-branch-name | Override the branch name, useful for manually helping calculate the branch name | N/A | false |

0 commit comments

Comments
 (0)