From 9c085fe63cc777744cfaced7b3e1749c33f905b0 Mon Sep 17 00:00:00 2001 From: faergestad Date: Mon, 2 Sep 2024 15:02:18 +0200 Subject: [PATCH] Update readme --- README.md | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 5146281..3da849b 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,15 @@ # terraform-digitalekanaler-apprunner-internal -Terraform module for internal applications hosted on vylabs.io +Terraform module for internal applications hosted on vylabs.io +See `/example` for usage -See example for usage \ No newline at end of file +## Release + +This library is configured to release automatically with GitHub Actions. PR title, and the final commit message after squash and merge, _must_ include one of the following tags: + +- [skip ci] -> the commit will not be picked up by GitHub Actions and no release will be made +- [patch] -> the commit does not add functionality, and does not break existing functionality +- [minor] -> the commit adds new functionality without breaking existing functionality +- [major] -> the commit breaks existing functionality + +The tag will decide which version this library will be released at. Read more about semantic +versioning [here](https://semver.org/). \ No newline at end of file