Skip to content

Commit

Permalink
add release docs and changelog.adoc
Browse files Browse the repository at this point in the history
  • Loading branch information
PacoVK committed Oct 23, 2023
1 parent 6577e7e commit 893be9a
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 0 deletions.
15 changes: 15 additions & 0 deletions dev/docs/release.adoc
Original file line number Diff line number Diff line change
@@ -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
14 changes: 14 additions & 0 deletions src/changelog.adoc
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit 893be9a

Please sign in to comment.