Skip to content

Commit 415bafb

Browse files
marcincubermarcincuber
authored
Feature/updates (#13)
* update docs and add chglog * Add CHANGELOG.md
1 parent 2253c1f commit 415bafb

File tree

5 files changed

+243
-6
lines changed

5 files changed

+243
-6
lines changed

‎.chglog/CHANGELOG.tpl.md‎

Lines changed: 111 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,111 @@
1+
# Change Log
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
{{ if .Versions -}}
6+
<a name="unreleased"></a>
7+
## [Unreleased]
8+
{{ if .Unreleased.CommitGroups -}}
9+
{{ range .Unreleased.CommitGroups -}}
10+
### {{ .Title }}
11+
{{ range .Commits -}}
12+
{{/* SKIPPING RULES - START */ -}}
13+
{{- if not (hasPrefix .Subject "Updated CHANGELOG") -}}
14+
{{- if not (contains .Subject "[ci skip]") -}}
15+
{{- if not (contains .Subject "[skip ci]") -}}
16+
{{- if not (hasPrefix .Subject "Merge pull request ") -}}
17+
{{- if not (hasPrefix .Subject "Added CHANGELOG") -}}
18+
{{- /* SKIPPING RULES - END */ -}}
19+
- {{ if .Scope }}**{{ .Scope }}:** {{ end }}{{ .Subject }}
20+
{{/* SKIPPING RULES - START */ -}}
21+
{{ end -}}
22+
{{ end -}}
23+
{{ end -}}
24+
{{ end -}}
25+
{{ end -}}
26+
{{/* SKIPPING RULES - END */ -}}
27+
{{ end }}
28+
{{ end -}}
29+
{{ else }}
30+
{{ range .Unreleased.Commits -}}
31+
{{/* SKIPPING RULES - START */ -}}
32+
{{- if not (hasPrefix .Subject "Updated CHANGELOG") -}}
33+
{{- if not (contains .Subject "[ci skip]") -}}
34+
{{- if not (contains .Subject "[skip ci]") -}}
35+
{{- if not (hasPrefix .Subject "Merge pull request ") -}}
36+
{{- if not (hasPrefix .Subject "Added CHANGELOG") -}}
37+
{{- /* SKIPPING RULES - END */ -}}
38+
- {{ if .Scope }}**{{ .Scope }}:** {{ end }}{{ .Subject }}
39+
{{/* SKIPPING RULES - START */ -}}
40+
{{ end -}}
41+
{{ end -}}
42+
{{ end -}}
43+
{{ end -}}
44+
{{ end -}}
45+
{{/* SKIPPING RULES - END */ -}}
46+
{{ end }}
47+
{{ end -}}
48+
{{ end -}}
49+
50+
{{ range .Versions }}
51+
<a name="{{ .Tag.Name }}"></a>
52+
## {{ if .Tag.Previous }}[{{ .Tag.Name }}]{{ else }}{{ .Tag.Name }}{{ end }} - {{ datetime "2006-01-02" .Tag.Date }}
53+
{{ if .CommitGroups -}}
54+
{{ range .CommitGroups -}}
55+
### {{ .Title }}
56+
{{ range .Commits -}}
57+
{{/* SKIPPING RULES - START */ -}}
58+
{{- if not (hasPrefix .Subject "Updated CHANGELOG") -}}
59+
{{- if not (contains .Subject "[ci skip]") -}}
60+
{{- if not (contains .Subject "[skip ci]") -}}
61+
{{- if not (hasPrefix .Subject "Merge pull request ") -}}
62+
{{- if not (hasPrefix .Subject "Added CHANGELOG") -}}
63+
{{- /* SKIPPING RULES - END */ -}}
64+
- {{ if .Scope }}**{{ .Scope }}:** {{ end }}{{ .Subject }}
65+
{{/* SKIPPING RULES - START */ -}}
66+
{{ end -}}
67+
{{ end -}}
68+
{{ end -}}
69+
{{ end -}}
70+
{{ end -}}
71+
{{/* SKIPPING RULES - END */ -}}
72+
{{ end }}
73+
{{ end -}}
74+
{{ else }}
75+
{{ range .Commits -}}
76+
{{/* SKIPPING RULES - START */ -}}
77+
{{- if not (hasPrefix .Subject "Updated CHANGELOG") -}}
78+
{{- if not (contains .Subject "[ci skip]") -}}
79+
{{- if not (contains .Subject "[skip ci]") -}}
80+
{{- if not (hasPrefix .Subject "Merge pull request ") -}}
81+
{{- if not (hasPrefix .Subject "Added CHANGELOG") -}}
82+
{{- /* SKIPPING RULES - END */ -}}
83+
- {{ if .Scope }}**{{ .Scope }}:** {{ end }}{{ .Subject }}
84+
{{/* SKIPPING RULES - START */ -}}
85+
{{ end -}}
86+
{{ end -}}
87+
{{ end -}}
88+
{{ end -}}
89+
{{ end -}}
90+
{{/* SKIPPING RULES - END */ -}}
91+
{{ end }}
92+
{{ end -}}
93+
94+
{{- if .NoteGroups -}}
95+
{{ range .NoteGroups -}}
96+
### {{ .Title }}
97+
{{ range .Notes }}
98+
{{ .Body }}
99+
{{ end }}
100+
{{ end -}}
101+
{{ end -}}
102+
{{ end -}}
103+
104+
{{- if .Versions }}
105+
[Unreleased]: {{ .Info.RepositoryURL }}/compare/{{ $latest := index .Versions 0 }}{{ $latest.Tag.Name }}...HEAD
106+
{{ range .Versions -}}
107+
{{ if .Tag.Previous -}}
108+
[{{ .Tag.Name }}]: {{ $.Info.RepositoryURL }}/compare/{{ .Tag.Previous.Name }}...{{ .Tag.Name }}
109+
{{ end -}}
110+
{{ end -}}
111+
{{ end -}}

‎.chglog/config.yml‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
style: github
2+
template: CHANGELOG.tpl.md
3+
info:
4+
title: CHANGELOG
5+
repository_url: https://github.com/umotif-public/terraform-aws-ecs-fargate
6+
options:
7+
header:
8+
pattern: "^(.*)$"
9+
pattern_maps:
10+
- Subject

‎CHANGELOG.md‎

Lines changed: 106 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,106 @@
1+
# Change Log
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
<a name="unreleased"></a>
6+
## [Unreleased]
7+
8+
- update docs and add chglog
9+
10+
11+
<a name="1.2.0"></a>
12+
## [1.2.0] - 2020-04-14
13+
14+
- Add support for additional variables and configuration options. ([#12](https://github.com/umotif-public/terraform-aws-ecs-fargate/issues/12))
15+
16+
17+
<a name="1.1.1"></a>
18+
## [1.1.1] - 2020-03-19
19+
20+
- lb_target reference fix
21+
22+
23+
<a name="1.1.0"></a>
24+
## [1.1.0] - 2020-03-19
25+
26+
- Feature/task healthcheck ([#11](https://github.com/umotif-public/terraform-aws-ecs-fargate/issues/11))
27+
- Add support for FARGATE-SPOT capacity provider and extend options for task definition ([#10](https://github.com/umotif-public/terraform-aws-ecs-fargate/issues/10))
28+
- add git hooks and update docs ([#9](https://github.com/umotif-public/terraform-aws-ecs-fargate/issues/9))
29+
30+
31+
<a name="1.0.9"></a>
32+
## [1.0.9] - 2020-01-31
33+
34+
- Feature/encrypt logs ([#8](https://github.com/umotif-public/terraform-aws-ecs-fargate/issues/8))
35+
36+
37+
<a name="1.0.8"></a>
38+
## [1.0.8] - 2020-01-14
39+
40+
- Feature/healthcheck grace fix ([#7](https://github.com/umotif-public/terraform-aws-ecs-fargate/issues/7))
41+
42+
43+
<a name="1.0.7"></a>
44+
## [1.0.7] - 2020-01-10
45+
46+
- Feature/lb toggle ([#6](https://github.com/umotif-public/terraform-aws-ecs-fargate/issues/6))
47+
48+
49+
<a name="1.0.6"></a>
50+
## [1.0.6] - 2020-01-09
51+
52+
- fix format
53+
- doh! ([#5](https://github.com/umotif-public/terraform-aws-ecs-fargate/issues/5))
54+
55+
56+
<a name="1.0.5"></a>
57+
## [1.0.5] - 2020-01-09
58+
59+
- Feature/improve tg naming ([#4](https://github.com/umotif-public/terraform-aws-ecs-fargate/issues/4))
60+
61+
62+
<a name="1.0.4"></a>
63+
## [1.0.4] - 2020-01-09
64+
65+
- Feature/fix dynamic port mapping ([#3](https://github.com/umotif-public/terraform-aws-ecs-fargate/issues/3))
66+
67+
68+
<a name="1.0.3"></a>
69+
## [1.0.3] - 2020-01-08
70+
71+
- fix format and update docs
72+
73+
74+
<a name="1.0.2"></a>
75+
## [1.0.2] - 2020-01-08
76+
77+
- improve tag support and expose host port ([#1](https://github.com/umotif-public/terraform-aws-ecs-fargate/issues/1))
78+
79+
80+
<a name="1.0.1"></a>
81+
## [1.0.1] - 2019-12-19
82+
83+
- improve docs and auto generating of inputs/outputs
84+
85+
86+
<a name="1.0.0"></a>
87+
## 1.0.0 - 2019-12-17
88+
89+
- add licence
90+
- Add initial configuration for ecs fargate module
91+
- Initial commit
92+
93+
94+
[Unreleased]: https://github.com/umotif-public/terraform-aws-ecs-fargate/compare/1.2.0...HEAD
95+
[1.2.0]: https://github.com/umotif-public/terraform-aws-ecs-fargate/compare/1.1.1...1.2.0
96+
[1.1.1]: https://github.com/umotif-public/terraform-aws-ecs-fargate/compare/1.1.0...1.1.1
97+
[1.1.0]: https://github.com/umotif-public/terraform-aws-ecs-fargate/compare/1.0.9...1.1.0
98+
[1.0.9]: https://github.com/umotif-public/terraform-aws-ecs-fargate/compare/1.0.8...1.0.9
99+
[1.0.8]: https://github.com/umotif-public/terraform-aws-ecs-fargate/compare/1.0.7...1.0.8
100+
[1.0.7]: https://github.com/umotif-public/terraform-aws-ecs-fargate/compare/1.0.6...1.0.7
101+
[1.0.6]: https://github.com/umotif-public/terraform-aws-ecs-fargate/compare/1.0.5...1.0.6
102+
[1.0.5]: https://github.com/umotif-public/terraform-aws-ecs-fargate/compare/1.0.4...1.0.5
103+
[1.0.4]: https://github.com/umotif-public/terraform-aws-ecs-fargate/compare/1.0.3...1.0.4
104+
[1.0.3]: https://github.com/umotif-public/terraform-aws-ecs-fargate/compare/1.0.2...1.0.3
105+
[1.0.2]: https://github.com/umotif-public/terraform-aws-ecs-fargate/compare/1.0.1...1.0.2
106+
[1.0.1]: https://github.com/umotif-public/terraform-aws-ecs-fargate/compare/1.0.0...1.0.1

‎Makefile‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ ifneq (,)
22
.error This Makefile requires GNU Make.
33
endif
44

5-
.PHONY: hooks validate
5+
.PHONY: hooks validate changelog
66

77
help:
88
@grep -E '^[a-zA-Z0-9_-]+:.*?## .*$$' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'
@@ -14,3 +14,6 @@ hooks: ## Commit hooks setup
1414

1515
validate: ## Validate files with pre-commit hooks
1616
@pre-commit run --all-files
17+
18+
changelog:
19+
git-chglog -o CHANGELOG.md

‎README.md‎

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,10 @@ Module is to be used with Terraform > 0.12.
7070
Module managed by [Marcin Cuber](https://github.com/marcincuber) [LinkedIn](https://www.linkedin.com/in/marcincuber/).
7171

7272
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
73+
## Requirements
74+
75+
No requirements.
76+
7377
## Providers
7478

7579
| Name | Version |
@@ -80,7 +84,7 @@ Module managed by [Marcin Cuber](https://github.com/marcincuber) [LinkedIn](http
8084
## Inputs
8185

8286
| Name | Description | Type | Default | Required |
83-
|------|-------------|------|---------|:-----:|
87+
|------|-------------|------|---------|:--------:|
8488
| capacity\_provider\_strategy | (Optional) The capacity\_provider\_strategy configuration block. This is a list of maps, where each map should contain "capacity\_provider ", "weight" and "base" | `list` | `[]` | no |
8589
| cluster\_id | The Amazon Resource Name (ARN) that identifies the cluster. | `string` | n/a | yes |
8690
| container\_name | Optional name for the container to be used instead of name\_prefix. | `string` | `""` | no |
@@ -107,17 +111,17 @@ Module managed by [Marcin Cuber](https://github.com/marcincuber) [LinkedIn](http
107111
| target\_group\_name | The name for the tasks target group | `string` | `""` | no |
108112
| task\_container\_assign\_public\_ip | Assigned public IP to the container. | `bool` | `false` | no |
109113
| task\_container\_command | The command that is passed to the container. | `list(string)` | `[]` | no |
110-
| task\_container\_cpu | Amount of CPU to reserve for the container. | `number` | n/a | yes |
114+
| task\_container\_cpu | Amount of CPU to reserve for the container. | `number` | `null` | no |
111115
| task\_container\_environment | The environment variables to pass to a container. | `map(string)` | `{}` | no |
112116
| task\_container\_image | The image used to start a container. | `string` | n/a | yes |
113-
| task\_container\_memory | The hard limit (in MiB) of memory for the container. | `number` | n/a | yes |
114-
| task\_container\_memory\_reservation | The soft limit (in MiB) of memory to reserve for the container. | `number` | n/a | yes |
117+
| task\_container\_memory | The hard limit (in MiB) of memory for the container. | `number` | `null` | no |
118+
| task\_container\_memory\_reservation | The soft limit (in MiB) of memory to reserve for the container. | `number` | `null` | no |
115119
| task\_container\_port | The port number on the container that is bound to the user-specified or automatically assigned host port | `number` | n/a | yes |
116120
| task\_container\_protocol | Protocol that the container exposes. | `string` | `"HTTP"` | no |
117121
| task\_container\_working\_directory | The working directory to run commands inside the container. | `string` | `""` | no |
118122
| task\_definition\_cpu | Amount of CPU to reserve for the task. | `number` | `256` | no |
119123
| task\_definition\_memory | The soft limit (in MiB) of memory to reserve for the task. | `number` | `512` | no |
120-
| task\_health\_check | An optional healthcheck definition for the task | `object({ command = list(string), interval = number, timeout = number, retries = number, startPeriod = number })` | n/a | yes |
124+
| task\_health\_check | An optional healthcheck definition for the task | `object({ command = list(string), interval = number, timeout = number, retries = number, startPeriod = number })` | `null` | no |
121125
| task\_host\_port | The port number on the container instance to reserve for your container. | `number` | `0` | no |
122126
| volume | (Optional) A set of volume blocks that containers in your task may use. This is a list of maps, where each map should contain "name", "host\_path", "docker\_volume\_configuration" and "efs\_volume\_configuration". Full set of options can be found at https://www.terraform.io/docs/providers/aws/r/ecs_task_definition.html | `list` | `[]` | no |
123127
| vpc\_id | The VPC ID. | `string` | n/a | yes |
@@ -153,4 +157,7 @@ See LICENSE for full details.
153157

154158
```bash
155159
brew install pre-commit terraform-docs tflint
160+
161+
brew tap git-chglog/git-chglog
162+
brew install git-chglog
156163
```

0 commit comments

Comments
 (0)