aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorHampusM <hampus@hampusmat.com>2022-07-22 13:39:49 +0200
committerHampusM <hampus@hampusmat.com>2022-07-22 13:39:49 +0200
commite5ea69d8e92e2b683a3cbe608d89d62e59cacb88 (patch)
tree2e4313c4c8805ff4935c1b47a023759a69060805
parent4cb3884e24b3cba3347ff93475bbabd6fe18d2fa (diff)
docs: add changelog
-rwxr-xr-x.chglog/CHANGELOG.tpl.md38
-rwxr-xr-x.chglog/config.yml28
-rw-r--r--CHANGELOG.md42
3 files changed, 108 insertions, 0 deletions
diff --git a/.chglog/CHANGELOG.tpl.md b/.chglog/CHANGELOG.tpl.md
new file mode 100755
index 0000000..d6fe361
--- /dev/null
+++ b/.chglog/CHANGELOG.tpl.md
@@ -0,0 +1,38 @@
+{{ if .Versions -}}
+## Unreleased
+
+{{ if .Unreleased.CommitGroups -}}
+{{ range .Unreleased.CommitGroups -}}
+### {{ .Title }}
+{{ range .Commits -}}
+- {{ if .Scope }}**{{ .Scope }}:** {{ end }}{{ .Subject }}
+{{ end }}
+{{ end -}}
+{{ end -}}
+{{ end -}}
+
+{{ range .Versions }}
+## {{ .Tag.Name }} - {{ datetime "2006-01-02" .Tag.Date }}
+{{ range .CommitGroups -}}
+### {{ .Title }}
+{{ range .Commits -}}
+- {{ if .Scope }}**{{ .Scope }}:** {{ end }}{{ .Subject }}
+{{ end }}
+{{ end -}}
+
+{{- if .RevertCommits -}}
+### Reverts
+{{ range .RevertCommits -}}
+- {{ .Revert.Header }}
+{{ end }}
+{{ end -}}
+
+{{- if .NoteGroups -}}
+{{ range .NoteGroups -}}
+### {{ .Title }}
+{{ range .Notes }}
+{{ .Body }}
+{{ end }}
+{{ end -}}
+{{ end -}}
+{{ end -}} \ No newline at end of file
diff --git a/.chglog/config.yml b/.chglog/config.yml
new file mode 100755
index 0000000..65780be
--- /dev/null
+++ b/.chglog/config.yml
@@ -0,0 +1,28 @@
+style: none
+template: CHANGELOG.tpl.md
+info:
+ title: CHANGELOG
+ repository_url: https://git.hampusmat.com/syrette
+options:
+ commits:
+ # filters:
+ # Type:
+ # - feat
+ # - fix
+ # - perf
+ # - refactor
+ commit_groups:
+ # title_maps:
+ # feat: Features
+ # fix: Bug Fixes
+ # perf: Performance Improvements
+ # refactor: Code Refactoring
+ header:
+ pattern: "^(\\w*)(?:\\(([\\w\\$\\.\\-\\*\\s]*)\\))?\\:\\s(.*)$"
+ pattern_maps:
+ - Type
+ - Scope
+ - Subject
+ notes:
+ keywords:
+ - BREAKING CHANGE \ No newline at end of file
diff --git a/CHANGELOG.md b/CHANGELOG.md
new file mode 100644
index 0000000..d07ff66
--- /dev/null
+++ b/CHANGELOG.md
@@ -0,0 +1,42 @@
+## Unreleased
+
+
+## v0.1.0 - 2022-07-20
+### Build
+- use syrette_macros from crates.io
+
+### Chore
+- add repository & keywords to Cargo manifests
+
+### Docs
+- replace symlinked readme with a copy
+- add readme symlink to syrette
+- improve and clean up doc comment examples
+- split example into multiple files
+- correct declare_interface macro example
+- remove the crate root example
+- add example
+- add documentation comments
+- add readme
+
+### Feat
+- add binding factories to DI container
+- add DI container
+
+### Refactor
+- use aggressive clippy linting
+- remove unused intertrait code
+- rename the castable_to macro to declare_interface
+- reduce the capabilities of the castable_to macro
+- reorganize and improve macros
+- use common pointer type aliases
+- add dedicated interface & error modules
+- move injectable type provider to own file
+
+### Style
+- group imports
+- add rustfmt config
+
+### Test
+- add DI container unit tests
+