diff --git a/CHANGELOG.md b/CHANGELOG.md index f8c615ccb..5affe6ae2 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,7 +2,7 @@ This log will detail notable changes to MyBatis Dynamic SQL. Full details are available on the GitHub milestone pages. -## Release 1.5.0 - Unreleased +## Release 1.5.0 - April 21, 2023 GitHub milestone: [https://github.com/mybatis/mybatis-dynamic-sql/milestone/12?closed=1](https://github.com/mybatis/mybatis-dynamic-sql/milestone/12?closed=1) diff --git a/RELEASING.md b/RELEASING.md index 911fc8f01..1077f07e2 100644 --- a/RELEASING.md +++ b/RELEASING.md @@ -8,6 +8,10 @@ The project is released with the normal Maven release cycle except for the site. https://github.com/mybatis/committers-stuff/wiki/Release-Process 2. Make sure your SSH key is setup at GitHub +## Preparation + +1. Update the release date in the CHANGELOG + ## Release Process 1. Clone the main repo (with ssh), checkout the master branch @@ -27,19 +31,24 @@ in the normal release. Here's how to do it manually: 1. Clone the main repo and checkout the release tag: - `git clone git@github.com:mybatis/mybatis-dynamic-sql.git` - `cd mybatis-dynamic-sql` - - `git checkout mybatis-dynamic-sql-1.5.0` + - `git checkout mybatis-dynamic-sql-1.5.1` 2. `./mvnw clean site` 3. Checkout a copy of the main repo in a temp directory: - `mkdir ~/temp/temp-mybatis` - `cd ~/temp/temp-mybatis` - `git clone git@github.com:mybatis/mybatis-dynamic-sql.git` + - `cd mybatis-dynamic-sql` - `git checkout gh-pages` 4. Copy the generated site into the temp checkout: - - `cp -R <>/mybatis-dynamic-sql/target/site ~/temp/temp-mybatis/mybatis-dynamic-sql` + - `cp -R <>/mybatis-dynamic-sql/target/site/ ~/temp/temp-mybatis/mybatis-dynamic-sql` 5. Push the new site: - `cd ~/temp/temp-mybatis/mybatis-dynamic-sql` - `git add .` - - `git commit -m "Manual Site Update 1.5.0"` + - `git commit -m "Manual Site Update 1.5.1"` - `git push` 6. Delete the temporary checkout - `rm -R ~/temp/temp-mybatis` + +## After Releasing + +Draft a new release on GitHub and tie it to the new release tag.