diff --git a/dev/docs/release.adoc b/dev/docs/release.adoc new file mode 100644 index 00000000..bf74f673 --- /dev/null +++ b/dev/docs/release.adoc @@ -0,0 +1,15 @@ += How to release + +Tapir releases use [semantic versioning](https://semver.org/). + +== Bump version + +- set the version in `pom.xml` +- set the version in `src/main/resources/application.yml` +- set the version in `src/main/webui/package.json` +- set the version in `src/main/webui/src/components/Footer.tsx` +- update test snapshots + +== Publish +- update the changelog +- Draft a new release on GitHub diff --git a/src/changelog.adoc b/src/changelog.adoc new file mode 100644 index 00000000..33733584 --- /dev/null +++ b/src/changelog.adoc @@ -0,0 +1,14 @@ +== Changelog + +All notable changes to this project will be documented in this file + +The format is based on https://keepachangelog.com/en/1.0.0/[Keep a Changelog], +and this project adheres to https://semver.org/spec/v2.0.0.html[semantic versioning]. + +== Unreleased + +=== fixes + +=== added + +=== changed \ No newline at end of file