From ed5ea2cbbcefe0cbaf47076ade410eed71402c7b Mon Sep 17 00:00:00 2001 From: maxim Date: Thu, 14 Oct 2021 15:01:33 +0600 Subject: [PATCH] Initial commit for semver approach --- .chglog/CHANGELOG.tpl.md | 75 ++++++++++++++++++++++++++++++++ .chglog/config.yml | 54 +++++++++++++++++++++++ .github/CONTRIBUTING.md | 33 ++++++++++++++ .github/ISSUE_TEMPLATE.md | 29 ++++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 9 ++++ .github/semantic.yml | 30 +++++++++++++ CHANGELOG.previous.md | 43 ++++++++++++++++++ 7 files changed, 273 insertions(+) create mode 100644 .chglog/CHANGELOG.tpl.md create mode 100644 .chglog/config.yml create mode 100644 .github/CONTRIBUTING.md create mode 100644 .github/ISSUE_TEMPLATE.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md create mode 100644 .github/semantic.yml create mode 100644 CHANGELOG.previous.md diff --git a/.chglog/CHANGELOG.tpl.md b/.chglog/CHANGELOG.tpl.md new file mode 100644 index 00000000..1af11b84 --- /dev/null +++ b/.chglog/CHANGELOG.tpl.md @@ -0,0 +1,75 @@ +# Change Log + +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](http://keepachangelog.com/) and this +project adheres to [Semantic Versioning](http://semver.org/). + +{{ if .Versions -}} + +## [Unreleased] +{{ if .Unreleased.CommitGroups -}} +{{ range .Unreleased.CommitGroups -}} +{{ .Title }}: +{{ range .Commits -}} +{{- if .Subject -}} +- {{ if .Scope }}**{{ .Scope }}:** {{ end }}{{ .Subject | upperFirst }} +{{ end -}} +{{ end }} +{{ end -}} +{{ else }} +{{ range .Unreleased.Commits -}} +{{- if .Subject -}} +- {{ if .Scope }}**{{ .Scope }}:** {{ end }}{{ .Subject | upperFirst}} +{{ end -}} +{{ end }} +{{ end -}} + +{{- if .Unreleased.NoteGroups -}} +{{ range .Unreleased.NoteGroups -}} +{{ .Title }}: +{{ range .Notes -}} +- {{ .Body }} +{{ end }} +{{ end -}} +{{ end -}} +{{ end -}} + +{{ range .Versions }} + +## {{ if .Tag.Previous }}[{{ .Tag.Name }}]{{ else }}{{ .Tag.Name }}{{ end }} - {{ datetime "2006-01-02" .Tag.Date }} +{{ if .CommitGroups -}} +{{ range .CommitGroups -}} +{{ .Title }}: +{{ range .Commits -}} +{{- if .Subject -}} +- {{ if .Scope }}**{{ .Scope }}:** {{ end }}{{ .Subject | upperFirst }} +{{ end -}} +{{ end }} +{{ end -}} +{{ else }} +{{ range .Commits -}} +{{- if .Subject -}} +- {{ if .Scope }}**{{ .Scope }}:** {{ end }}{{ .Subject | upperFirst }} +{{ end -}} +{{ end }} +{{ end -}} + +{{- if .NoteGroups -}} +{{ range .NoteGroups -}} +{{ .Title }}: +{{ range .Notes -}} +- {{ .Body }} +{{ end }} +{{ end -}} +{{ end -}} +{{ end -}} + +{{- if .Versions }} +[Unreleased]: {{ .Info.RepositoryURL }}/compare/{{ $latest := index .Versions 0 }}{{ $latest.Tag.Name }}...HEAD +{{ range .Versions -}} +{{ if .Tag.Previous -}} +[{{ .Tag.Name }}]: {{ $.Info.RepositoryURL }}/compare/{{ .Tag.Previous.Name }}...{{ .Tag.Name }} +{{ end -}} +{{ end -}} +{{ end -}} diff --git a/.chglog/config.yml b/.chglog/config.yml new file mode 100644 index 00000000..9749bef4 --- /dev/null +++ b/.chglog/config.yml @@ -0,0 +1,54 @@ +style: github +template: CHANGELOG.tpl.md +info: + title: CHANGELOG + repository_url: https://github.com/maddevsio/aws-eks-base +options: + commits: + sort_by: Type + filters: + Type: + - feat + - fix + - improvement + - docs + - refactor + - test + - ci + + commit_groups: + group_by: Type + sort_by: Custom + title_order: + - feat + - improvement + - refactor + - fix + - docs + - test + - ci + title_maps: + feat: FEATURES + fix: BUG FIXES + improvement: ENHANCEMENTS + docs: DOCS + refactor: REFACTORS + test: TESTS + ci: CI + + header: + pattern: "^(.+)\\s*:\\s*(.+)$" + pattern_maps: + - Type + - Subject + + notes: + keywords: + - BREAKING CHANGES + - NOTES + + refs: + actions: + - Closes + - Fixes + - Resolves diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 00000000..170eaca1 --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,33 @@ +# Contributing + +When contributing to this repository, please first discuss the change you wish to make via issue, +email, or any other method with the owners of this repository before making a change. + +Please note we have a code of conduct, please follow it in all your interactions with the project. + +## Pull Request Process + +1. Ensure any install or build dependencies are removed before the end of the layer when doing a build. +2. Update the README.md with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations, and container parameters. +3. Once all outstanding comments and checklist items have been addressed, your contribution will be merged! Merged PRs will be included in the next release. The aws-eks-base maintainers take care of updating the CHANGELOG as they merge. + +## Checklists for contributions + +- [ ] Add [semantics prefix](#semantic-pull-requests) to your PR or Commits (at least one of your commit groups) +- [ ] CI tests are passing + +## Semantic Pull Requests + +To generate changelog, Pull Requests or Commits must have semantic and must follow conventional specs below: + +- `feat:` for new features +- `fix:` for bug fixes +- `improvement:` for enhancements +- `docs:` for documentation and examples +- `refactor:` for code refactoring +- `test:` for tests +- `ci:` for CI purpose +- `chore:` for chores stuff + +The `chore` prefix skipped during changelog generation. It can be used for `chore: update changelog` commit message by example. + diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 00000000..356faf3a --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,29 @@ +# I have issues + +## I'm submitting a... + +* [ ] bug report +* [ ] feature request +* [ ] improvement request + +## What is the current behavior? + + + +## If this is a bug, how to reproduce? Please include a code sample if relevant. + + + +## What's the expected behavior? + + + +## Are you able to fix this problem and submit a PR? Link here if you have already. + +## Environment details + +* Affected module version: +* OS: +* Terraform version: + +## Any other relevant info diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..102d8a12 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,9 @@ +# PR o'clock + +## Description + +Please explain the changes you made here and link to any relevant issues. + +### Checklist + +- [ ] Update the README.md with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations, and container parameters. diff --git a/.github/semantic.yml b/.github/semantic.yml new file mode 100644 index 00000000..376c06a6 --- /dev/null +++ b/.github/semantic.yml @@ -0,0 +1,30 @@ +# Always validate the PR title, and ignore the commits +titleOnly: true + +# Always validate all commits, and ignore the PR title +commitsOnly: false + +# Always validate the PR title AND all the commits +titleAndCommits: false + +# Require at least one commit to be valid +# this is only relevant when using commitsOnly: true or titleAndCommits: true, +# which validate all commits by default +anyCommit: false + +# By default types specified in commitizen/conventional-commit-types is used. +# See: https://github.com/commitizen/conventional-commit-types/blob/v2.3.0/index.json +# You can override the valid types +types: + - feat + - fix + - improvement + - docs + - refactor + - test + - ci + - chore + +# Allow use of Merge commits (eg on github: "Merge branch 'master' into feature/ride-unicorns") +# this is only relevant when using commitsOnly: true (or titleAndCommits: true) +allowMergeCommits: false diff --git a/CHANGELOG.previous.md b/CHANGELOG.previous.md new file mode 100644 index 00000000..2ab3d07d --- /dev/null +++ b/CHANGELOG.previous.md @@ -0,0 +1,43 @@ + +## [Unreleased] + + + +## 1.0.0 - 2021-10-14 +### HotFix +- add allowed_account_ids varialbe to layer2 + +### Pull Requests +- Merge pull request [#116](https://github.com/maddevsio/aws-eks-base/issues/116) from maddevsio/Feature/add_depends_on_eks_modify_readme +- Merge pull request [#115](https://github.com/maddevsio/aws-eks-base/issues/115) from maddevsio/Feature/aws_eks_addon_depends_on +- Merge pull request [#111](https://github.com/maddevsio/aws-eks-base/issues/111) from maddevsio/Feature/eks_depends_on_vpc +- Merge pull request [#110](https://github.com/maddevsio/aws-eks-base/issues/110) from maddevsio/eks-addons +- Merge pull request [#104](https://github.com/maddevsio/aws-eks-base/issues/104) from maddevsio/tfsec +- Merge pull request [#93](https://github.com/maddevsio/aws-eks-base/issues/93) from maddevsio/feature/k8s-secrets-encryption +- Merge pull request [#58](https://github.com/maddevsio/aws-eks-base/issues/58) from maddevsio/feature/pinned-terragrunt-version +- Merge pull request [#59](https://github.com/maddevsio/aws-eks-base/issues/59) from maddevsio/feature/terraform-utils +- Merge pull request [#55](https://github.com/maddevsio/aws-eks-base/issues/55) from maddevsio/fix/filebeat-configuration +- Merge pull request [#56](https://github.com/maddevsio/aws-eks-base/issues/56) from maddevsio/fix/aws-iam-s3 +- Merge pull request [#53](https://github.com/maddevsio/aws-eks-base/issues/53) from maddevsio/feature/add-depends-on +- Merge pull request [#51](https://github.com/maddevsio/aws-eks-base/issues/51) from maddevsio/feature/update-terraform-and-terraform-providers +- Merge pull request [#50](https://github.com/maddevsio/aws-eks-base/issues/50) from maddevsio/feature/change-log-level +- Merge pull request [#47](https://github.com/maddevsio/aws-eks-base/issues/47) from maddevsio/ebs_encryption +- Merge pull request [#46](https://github.com/maddevsio/aws-eks-base/issues/46) from maddevsio/ebs_encryption +- Merge pull request [#44](https://github.com/maddevsio/aws-eks-base/issues/44) from maddevsio/count_of_helm_releases +- Merge pull request [#38](https://github.com/maddevsio/aws-eks-base/issues/38) from maddevsio/fix/prometheus-stack +- Merge pull request [#29](https://github.com/maddevsio/aws-eks-base/issues/29) from maddevsio/feature/Add-github-actions-ci +- Merge pull request [#33](https://github.com/maddevsio/aws-eks-base/issues/33) from AntonGrushkin/antongrushkin +- Merge pull request [#31](https://github.com/maddevsio/aws-eks-base/issues/31) from maddevsio/feature/variables-cleanup +- Merge pull request [#24](https://github.com/maddevsio/aws-eks-base/issues/24) from maddevsio/feature/license-badge +- Merge pull request [#23](https://github.com/maddevsio/aws-eks-base/issues/23) from maddevsio/fix/ru-readme +- Merge pull request [#21](https://github.com/maddevsio/aws-eks-base/issues/21) from maddevsio/fix/prom-template-error +- Merge pull request [#20](https://github.com/maddevsio/aws-eks-base/issues/20) from maddevsio/feature/adv-of-the-boiler +- Merge pull request [#17](https://github.com/maddevsio/aws-eks-base/issues/17) from maddevsio/fix/digram-fix +- Merge pull request [#16](https://github.com/maddevsio/aws-eks-base/issues/16) from maddevsio/fix/analytics +- Merge pull request [#15](https://github.com/maddevsio/aws-eks-base/issues/15) from maddevsio/feature/analytics +- Merge pull request [#13](https://github.com/maddevsio/aws-eks-base/issues/13) from maddevsio/pritunl_efs +- Merge pull request [#11](https://github.com/maddevsio/aws-eks-base/issues/11) from maddevsio/fix_variable_for_aws_iam_policy_document +- Merge pull request [#12](https://github.com/maddevsio/aws-eks-base/issues/12) from maddevsio/Tools_for_cubectl + + +[Unreleased]: https://github.com/maddevsio/aws-eks-base/compare/1.0.0...HEAD