Skip to content

Commit 0d425c5

Browse files
sleistnersleistner
authored
Merge pull request #12 from enter-at/github-actions/auto-readme-1595421227
Automatic Update of README.md
2 parents 3ce1a83 + 3d9cf69 commit 0d425c5

File tree

4 files changed

+324
-1
lines changed

4 files changed

+324
-1
lines changed

‎.README.md.gotmpl‎

Lines changed: 184 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,184 @@
1+
<!--
2+
3+
** DO NOT EDIT THIS FILE
4+
**
5+
** This file was automatically generated by the `build-harness`.
6+
** 1) Make all changes to `README.yaml`
7+
** 2) Run `make init` (you only need to do this once)
8+
** 3) Run`make readme` to rebuild this file.
9+
**
10+
11+
-->
12+
{{- defineDatasource "config" .Env.README_YAML | regexp.Replace ".*" "" -}}
13+
{{- defineDatasource "includes" .Env.README_INCLUDES | regexp.Replace ".*" "" }}
14+
15+
[<img src="https://res.cloudinary.com/enter-at/image/upload/v1576145406/static/logo-svg.svg" alt="enter-at" width="100">][website]
16+
17+
# {{(ds "config").name}}{{ if gt (len (ds "config").name) 34 }}{{ print "\n\n" }}{{ end }}{{ if has (ds "config") "badges" }}{{- range $badge := (ds "config").badges -}}{{ printf " [![%s](%s)](%s)" $badge.name $badge.image $badge.url }}{{ end }}{{ end }}
18+
19+
{{ if has (ds "config") "logo" }}
20+
![{{(ds "config").name}}]({{ (ds "config").logo }})
21+
{{- end -}}
22+
23+
{{ if has (ds "config") "description" }}
24+
{{(ds "config").description }}
25+
{{ end }}
26+
27+
---
28+
29+
{{ if eq (ds "config").license "APACHE2" }}
30+
It's 100% Open Source and licensed under the [APACHE2](LICENSE).
31+
{{ end }}
32+
33+
{{ if has (ds "config") "screenshots" }}
34+
## Screenshots
35+
36+
{{ range $screenshot := (ds "config").screenshots }}
37+
{{ printf "![%s](%s)\n*%s*" $screenshot.name $screenshot.url $screenshot.description }}{{ end }}
38+
{{ end }}
39+
{{ if has (ds "config") "introduction" }}
40+
## Introduction
41+
42+
{{ (ds "config").introduction -}}
43+
{{ end }}
44+
{{ if has (ds "config") "usage" }}
45+
## Usage
46+
47+
{{ if (file.Exists "main.tf") }}
48+
**IMPORTANT:** The `master` branch is used in `source` just as an example. In your code, do not pin to `master` because there may be breaking changes between releases.
49+
Instead pin to the release tag (e.g. `?ref=tags/x.y.z`) of one of our [latest releases]({{ printf "https://github.com/%s/releases" (ds "config").github_repo}}).
50+
{{end}}
51+
52+
{{ (ds "config").usage -}}
53+
{{ end }}
54+
55+
{{ if has (ds "config") "quickstart" -}}
56+
## Quick Start
57+
58+
{{ (ds "config").quickstart -}}
59+
{{ end }}
60+
61+
{{ if has (ds "config") "examples" }}
62+
## Examples
63+
64+
{{(ds "config").examples }}
65+
{{ end }}
66+
67+
{{ if has (ds "config") "api" }}
68+
## API
69+
70+
{{(ds "config").api }}
71+
{{ end }}
72+
73+
{{ if has (ds "config") "include" }}
74+
{{ range $file := (datasource "config").include -}}
75+
{{ (include "includes" $file) }}
76+
{{- end }}
77+
{{- end }}
78+
{{ if has (ds "config") "related" }}
79+
80+
## Share the Love
81+
82+
Like this project?
83+
Please give it a ★ on [our GitHub]({{ printf "https://github.com/%s" (ds "config").github_repo}})!
84+
85+
86+
## Related Projects
87+
88+
Check out these related projects.
89+
{{ range $related := (ds "config").related }}
90+
{{ printf "- [%s](%s) - %s" $related.name $related.url $related.description }}{{ end }}
91+
92+
{{ end}}
93+
{{ if has (ds "config") "references" }}
94+
95+
## References
96+
97+
For additional context, refer to some of these links.
98+
{{ range $reference := (ds "config").references }}
99+
{{ printf "- [%s](%s) - %s" $reference.name $reference.url $reference.description }}{{ end }}
100+
101+
{{ end}}
102+
## Help
103+
104+
**Got a question?**
105+
106+
File a GitHub [issue]({{ printf "https://github.com/%s/issues" (ds "config").github_repo}}).
107+
108+
## Contributing
109+
110+
### Bug Reports & Feature Requests
111+
112+
Please use the [issue tracker]({{ printf "https://github.com/%s/issues" (ds "config").github_repo}}) to report any bugs or file feature requests.
113+
114+
### Developing
115+
116+
If you are interested in being a contributor and want to get involved in developing this project, we would love to hear from you!
117+
118+
In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.
119+
120+
1. **Fork** the repo on GitHub
121+
2. **Clone** the project to your own machine
122+
3. **Commit** changes to your own branch
123+
4. **Push** your work back up to your fork
124+
5. Submit a **Pull Request** so that we can review your changes
125+
126+
**NOTE:** Be sure to merge the latest changes from "upstream" before making a pull request!
127+
128+
{{ if has (ds "config") "copyrights" }}
129+
130+
## Copyrights
131+
132+
{{ range $copyright := (ds "config").copyrights -}}
133+
{{ printf "Copyright © %s-%d [%s](%s)\n" $copyright.year time.Now.Year $copyright.name $copyright.url }}
134+
{{ end }}
135+
{{ end }}
136+
137+
138+
{{ if eq (ds "config").license "APACHE2" }}
139+
## License
140+
141+
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
142+
143+
See [LICENSE](LICENSE) for full details.
144+
145+
Licensed to the Apache Software Foundation (ASF) under one
146+
or more contributor license agreements. See the NOTICE file
147+
distributed with this work for additional information
148+
regarding copyright ownership. The ASF licenses this file
149+
to you under the Apache License, Version 2.0 (the
150+
"License"); you may not use this file except in compliance
151+
with the License. You may obtain a copy of the License at
152+
153+
https://www.apache.org/licenses/LICENSE-2.0
154+
155+
Unless required by applicable law or agreed to in writing,
156+
software distributed under the License is distributed on an
157+
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
158+
KIND, either express or implied. See the License for the
159+
specific language governing permissions and limitations
160+
under the License.
161+
{{ end }}
162+
163+
164+
{{ if has (datasource "config") "contributors" }}
165+
### Contributors
166+
167+
{{ range $contributor := (ds "config").contributors }}
168+
{{ printf "[![%s][%s_avatar]][%s_homepage]" $contributor.name $contributor.github $contributor.github }}
169+
{{ end }}
170+
171+
{{ range $contributor := (ds "config").contributors -}}
172+
{{- if has $contributor "homepage" }}
173+
{{ printf " [%s_homepage]: %s" $contributor.github $contributor.homepage }}
174+
{{ else -}}
175+
{{ printf " [%s_homepage]: https://github.com/%s" $contributor.github $contributor.github }}
176+
{{ end -}}
177+
{{ if has $contributor "avatar" }}{{ printf " [%s_avatar]: %s" $contributor.github $contributor.avatar }}
178+
{{ else -}}
179+
{{ printf " [%s_avatar]: https://res.cloudinary.com/enter-at/image/fetch/f_png,r_max,w_100,h_100,c_thumb/https://github.com/%s.png" $contributor.github $contributor.github }}
180+
{{- end }}
181+
{{ end }}
182+
{{ end }}
183+
184+
[website]: https://github.com/enter-at

‎.build-harness‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
export SHELL = /bin/bash
2+
export BUILD_HARNESS_ORG ?= cloudposse
3+
export BUILD_HARNESS_PROJECT ?= build-harness
4+
export BUILD_HARNESS_BRANCH ?= master
5+
export BUILD_HARNESS_PATH ?= $(shell until [ -d "$(BUILD_HARNESS_PROJECT)" ] || [ "`pwd`" == '/' ]; do cd ..; done; pwd)/$(BUILD_HARNESS_PROJECT)
6+
-include $(BUILD_HARNESS_PATH)/Makefile
7+
8+
.PHONY : init
9+
## Init build-harness
10+
init::
11+
@curl --retry 5 --fail --silent --retry-delay 1 https://raw.githubusercontent.com/$(BUILD_HARNESS_ORG)/$(BUILD_HARNESS_PROJECT)/$(BUILD_HARNESS_BRANCH)/bin/install.sh | \
12+
bash -s "$(BUILD_HARNESS_ORG)" "$(BUILD_HARNESS_PROJECT)" "$(BUILD_HARNESS_BRANCH)"
13+
14+
.PHONY : clean
15+
## Clean build-harness
16+
clean::
17+
@[ "$(BUILD_HARNESS_PATH)" == '/' ] || \
18+
[ "$(BUILD_HARNESS_PATH)" == '.' ] || \
19+
echo rm -rf $(BUILD_HARNESS_PATH)

‎README.md‎

Lines changed: 120 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,121 @@
1-
# eslint-config-typescript-prettier
1+
<!--
2+
3+
** DO NOT EDIT THIS FILE
4+
**
5+
** This file was automatically generated by the `build-harness`.
6+
** 1) Make all changes to `README.yaml`
7+
** 2) Run `make init` (you only need to do this once)
8+
** 3) Run`make readme` to rebuild this file.
9+
**
10+
11+
-->
12+
13+
[<img src="https://res.cloudinary.com/enter-at/image/upload/v1576145406/static/logo-svg.svg" alt="enter-at" width="100">][website]
14+
15+
# eslint-config-typescript-prettier [![Build Status](https://github.com/enter-at/eslint-config-typescript-prettier/workflows/Lint%20&%20Test/badge.svg)](https://github.com/enter-at/eslint-config-typescript-prettier/actions) [![Release](https://img.shields.io/npm/v/@enter-at/eslint-config-typescript-prettier.svg)](https://www.npmjs.com/package/@enter-at/eslint-config-typescript-prettier) [![Install size](https://packagephobia.now.sh/badge?p=@enter-at/eslint-config-typescript-prettier)](https://packagephobia.now.sh/result?p=@enter-at/eslint-config-typescript-prettier)
16+
17+
218
Enterat's ESLint config with TypeScript and Prettier support.
19+
20+
21+
---
22+
23+
24+
It's 100% Open Source and licensed under the [APACHE2](LICENSE).
25+
26+
27+
28+
29+
30+
31+
## Quick Start
32+
33+
Install `typescript`, `eslint` and `prettier`, `@enter-at/eslint-config-typescript-prettier` and put it into your `.eslintrc.js`.
34+
35+
```bash
36+
$ npm install typescript eslint prettier @enter-at/eslint-config-typescript-prettier --save-dev
37+
```
38+
39+
`.eslintrc.js`
40+
41+
```js
42+
module.exports = {
43+
extends: "@enter-at/typescript-prettier"
44+
};
45+
```
46+
47+
48+
49+
50+
51+
52+
53+
54+
## Help
55+
56+
**Got a question?**
57+
58+
File a GitHub [issue](https://github.com/enter-at/eslint-config-typescript-prettier/issues).
59+
60+
## Contributing
61+
62+
### Bug Reports & Feature Requests
63+
64+
Please use the [issue tracker](https://github.com/enter-at/eslint-config-typescript-prettier/issues) to report any bugs or file feature requests.
65+
66+
### Developing
67+
68+
If you are interested in being a contributor and want to get involved in developing this project, we would love to hear from you!
69+
70+
In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.
71+
72+
1. **Fork** the repo on GitHub
73+
2. **Clone** the project to your own machine
74+
3. **Commit** changes to your own branch
75+
4. **Push** your work back up to your fork
76+
5. Submit a **Pull Request** so that we can review your changes
77+
78+
**NOTE:** Be sure to merge the latest changes from "upstream" before making a pull request!
79+
80+
81+
82+
83+
84+
## License
85+
86+
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
87+
88+
See [LICENSE](LICENSE) for full details.
89+
90+
Licensed to the Apache Software Foundation (ASF) under one
91+
or more contributor license agreements. See the NOTICE file
92+
distributed with this work for additional information
93+
regarding copyright ownership. The ASF licenses this file
94+
to you under the Apache License, Version 2.0 (the
95+
"License"); you may not use this file except in compliance
96+
with the License. You may obtain a copy of the License at
97+
98+
https://www.apache.org/licenses/LICENSE-2.0
99+
100+
Unless required by applicable law or agreed to in writing,
101+
software distributed under the License is distributed on an
102+
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
103+
KIND, either express or implied. See the License for the
104+
specific language governing permissions and limitations
105+
under the License.
106+
107+
108+
109+
110+
### Contributors
111+
112+
113+
[![Steffen Leistner][sleistner_avatar]][sleistner_homepage]
114+
115+
116+
[sleistner_homepage]: https://github.com/sleistner
117+
[sleistner_avatar]: https://res.cloudinary.com/enter-at/image/fetch/f_png,r_max,w_100,h_100,c_thumb/https://github.com/sleistner.png
118+
119+
120+
121+
[website]: https://github.com/enter-at

‎build-harness‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Subproject commit 7eb720820c9188643932b89a8a81af4ef603f2bf

0 commit comments

Comments
 (0)