Skip to content

Commit d5fb7a3

Browse files
authored
Update README to CloudPosse standard README.md format (#6)
* Update `README` * Update `README` * Update `README` * Update `README`
1 parent 58a0e0b commit d5fb7a3

File tree

3 files changed

+109
-2
lines changed

3 files changed

+109
-2
lines changed

.dockerignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,3 +6,5 @@
66
*.tfstate.*
77
.idea
88
*.iml
9+
.build-harness
10+
build-harness

README.md

Lines changed: 106 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,108 @@
1-
# terraform-root-modules
1+
![Cloud Posse](https://cloudposse.com/logo-300x69.png)
2+
3+
# terraform-root-modules ![Build Status](https://g.codefresh.io/api/badges/build?repoOwner=cloudposse&repoName=terraform-root-modules&branch=master&pipelineName=terraform-root-modules&accountName=cloudposse)
4+
25

36
This is a collection of reusable root modules for CloudPosse AWS accounts.
7+
8+
9+
## Usage
10+
11+
Use the `terraform-root-modules` Docker image as the base image in the application `Dockerfile`, and copy the modules from `/aws` folder into `/conf` folder
12+
13+
```dockerfile
14+
FROM cloudposse/terraform-root-modules:0.1.4 as terraform-root-modules
15+
16+
FROM cloudposse/geodesic:0.9.16
17+
18+
# Copy root modules into /conf folder
19+
COPY --from=terraform-root-modules /aws/ /conf/
20+
21+
WORKDIR /conf/
22+
```
23+
24+
25+
## Help
26+
27+
**Got a question?**
28+
29+
File a GitHub [issue](https://github.com/cloudposse/terraform-root-modules/issues), send us an [email](mailto:[email protected]) or reach out to us on [Gitter](https://gitter.im/cloudposse/).
30+
31+
32+
## Contributing
33+
34+
### Bug Reports & Feature Requests
35+
36+
Please use the [issue tracker](https://github.com/cloudposse/terraform-root-modules/issues) to report any bugs or file feature requests.
37+
38+
### Developing
39+
40+
If you are interested in being a contributor and want to get involved in developing `terraform-root-modules`, we would love to hear from you! Shoot us an [email](mailto:[email protected]).
41+
42+
In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.
43+
44+
1. **Fork** the repo on GitHub
45+
2. **Clone** the project to your own machine
46+
3. **Commit** changes to your own branch
47+
4. **Push** your work back up to your fork
48+
5. Submit a **Pull request** so that we can review your changes
49+
50+
**NOTE:** Be sure to merge the latest from "upstream" before making a pull request!
51+
52+
53+
## License
54+
55+
[APACHE 2.0](LICENSE) © 2018 [Cloud Posse, LLC](https://cloudposse.com)
56+
57+
See [LICENSE](LICENSE) for full details.
58+
59+
Licensed to the Apache Software Foundation (ASF) under one
60+
or more contributor license agreements. See the NOTICE file
61+
distributed with this work for additional information
62+
regarding copyright ownership. The ASF licenses this file
63+
to you under the Apache License, Version 2.0 (the
64+
"License"); you may not use this file except in compliance
65+
with the License. You may obtain a copy of the License at
66+
67+
http://www.apache.org/licenses/LICENSE-2.0
68+
69+
Unless required by applicable law or agreed to in writing,
70+
software distributed under the License is distributed on an
71+
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
72+
KIND, either express or implied. See the License for the
73+
specific language governing permissions and limitations
74+
under the License.
75+
76+
77+
## About
78+
79+
`terraform-root-modules` is maintained and funded by [Cloud Posse, LLC][website].
80+
81+
![Cloud Posse](https://cloudposse.com/logo-300x69.png)
82+
83+
84+
Like it? Please let us know at <[email protected]>
85+
86+
We love [Open Source Software](https://github.com/cloudposse/)!
87+
88+
See [our other projects][community]
89+
or [hire us][hire] to help build your next cloud platform.
90+
91+
[website]: https://cloudposse.com/
92+
[community]: https://github.com/cloudposse/
93+
[hire]: https://cloudposse.com/contact/
94+
95+
96+
## Contributors
97+
98+
| [![Erik Osterman][erik_img]][erik_web]<br/>[Erik Osterman][erik_web] | [![Andriy Knysh][andriy_img]][andriy_web]<br/>[Andriy Knysh][andriy_web] |[![Igor Rodionov][igor_img]][igor_web]<br/>[Igor Rodionov][igor_img]|[![Sarkis Varozian][sarkis_img]][sarkis_web]<br/>[Sarkis Varozian][sarkis_web] |
99+
|-------------------------------------------------------|------------------------------------------------------------------|------------------------------------------------------------------|------------------------------------------------------------------|
100+
101+
[erik_img]: http://s.gravatar.com/avatar/88c480d4f73b813904e00a5695a454cb?s=144
102+
[erik_web]: https://github.com/osterman/
103+
[andriy_img]: https://avatars0.githubusercontent.com/u/7356997?v=4&u=ed9ce1c9151d552d985bdf5546772e14ef7ab617&s=144
104+
[andriy_web]: https://github.com/aknysh/
105+
[igor_img]: http://s.gravatar.com/avatar/bc70834d32ed4517568a1feb0b9be7e2?s=144
106+
[igor_web]: https://github.com/goruha/
107+
[sarkis_img]: https://avatars3.githubusercontent.com/u/42673?s=144&v=4
108+
[sarkis_web]: https://github.com/sarkis/

codefresh.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ steps:
66
title: Init variables
77
image: alpine
88
commands:
9-
- cf_export BUILD_HARNESS_VERSION=0.5.4
9+
- cf_export BUILD_HARNESS_VERSION=0.5.5
1010
- cf_export GIT_BRANCH=${{CF_BRANCH}}
1111

1212
build_image:

0 commit comments

Comments
 (0)