From a28b4ff9a9acff455af366e0670d54bef7f37664 Mon Sep 17 00:00:00 2001
From: Duncan Brown <duncanjbrown@gmail.com>
Date: Fri, 10 Jun 2022 12:34:50 +0100
Subject: [PATCH] Changelog and release process

---
 CHANGELOG.md | 33 +++++++++++++++++++++++++++++++++
 README.md    | 12 ++++++++++++
 2 files changed, 45 insertions(+)
 create mode 100644 CHANGELOG.md

diff --git a/CHANGELOG.md b/CHANGELOG.md
new file mode 100644
index 00000000..84a720c9
--- /dev/null
+++ b/CHANGELOG.md
@@ -0,0 +1,33 @@
+# Changelog
+
+## [v1.0.0](https://github.com/DFE-Digital/dfe-analytics/tree/v1.0.0) (2022-06-10)
+
+[Full Changelog](https://github.com/DFE-Digital/dfe-analytics/compare/v0.1.0...v1.0.0)
+
+**Merged pull requests:**
+
+- Bump to v1 [\#15](https://github.com/DFE-Digital/dfe-analytics/pull/15) ([duncanjbrown](https://github.com/duncanjbrown))
+- add setup dummy db steps to reamde [\#14](https://github.com/DFE-Digital/dfe-analytics/pull/14) ([misaka](https://github.com/misaka))
+- fix raise to keep rubocop happy [\#13](https://github.com/DFE-Digital/dfe-analytics/pull/13) ([misaka](https://github.com/misaka))
+- Fix rake task when using arguments [\#12](https://github.com/DFE-Digital/dfe-analytics/pull/12) ([tomas-stefano](https://github.com/tomas-stefano))
+- add have\_sent\_analytics\_event rspec matcher  [\#11](https://github.com/DFE-Digital/dfe-analytics/pull/11) ([misaka](https://github.com/misaka))
+- Make Rails a development\_dependency [\#10](https://github.com/DFE-Digital/dfe-analytics/pull/10) ([duncanjbrown](https://github.com/duncanjbrown))
+- Set up Rubocop, run it in CI [\#9](https://github.com/DFE-Digital/dfe-analytics/pull/9) ([duncanjbrown](https://github.com/duncanjbrown))
+- Run specs on all PRs \(and fix a flaky spec\) [\#8](https://github.com/DFE-Digital/dfe-analytics/pull/8) ([duncanjbrown](https://github.com/duncanjbrown))
+- Configure ActiveJob retry \(max 5 attempts\) [\#7](https://github.com/DFE-Digital/dfe-analytics/pull/7) ([duncanjbrown](https://github.com/duncanjbrown))
+- Fix typo [\#5](https://github.com/DFE-Digital/dfe-analytics/pull/5) ([CristinaRO](https://github.com/CristinaRO))
+- Correct request spec [\#4](https://github.com/DFE-Digital/dfe-analytics/pull/4) ([duncanjbrown](https://github.com/duncanjbrown))
+- Use snake\_case for config file [\#3](https://github.com/DFE-Digital/dfe-analytics/pull/3) ([duncanjbrown](https://github.com/duncanjbrown))
+
+## [v0.1.0](https://github.com/DFE-Digital/dfe-analytics/tree/v0.1.0) (2022-04-21)
+
+[Full Changelog](https://github.com/DFE-Digital/dfe-analytics/compare/89c136eb84efcccbfabc823c5fb4aa2fc96ff6dd...v0.1.0)
+
+**Merged pull requests:**
+
+- Standardise event-schema.json [\#2](https://github.com/DFE-Digital/dfe-analytics/pull/2) ([duncanjbrown](https://github.com/duncanjbrown))
+- Add config options: queue name, BQ timeout, BQ retries [\#1](https://github.com/DFE-Digital/dfe-analytics/pull/1) ([duncanjbrown](https://github.com/duncanjbrown))
+
+
+
+\* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)*
diff --git a/README.md b/README.md
index e4487735..60a0b28d 100644
--- a/README.md
+++ b/README.md
@@ -210,6 +210,18 @@ bundle exec rails dfe:analytics:import_entity[ModelName]
 4. Run the tests: `bundle exec rspec`
 5. Run rubocop: `bundle exec rubocop`
 
+## Releasing
+
+Dependencies:
+
+- [github_changelog_generator](https://github.com/github-changelog-generator/Github-Changelog-Generator)
+- [gem_release](https://github.com/svenfuchs/gem-release) (or DIY)
+
+1. Raise a PR bumping the version and get it merged
+1. On `main`, tag the current version using `gem tag`. Tags should be in the form `vX.X.X`
+1. Push the tag: `git push origin <tag name>` (or use `gem tag -p` and skip this step)
+1. Generate a changelog: `github_changelog_generator -u DFE-Digital -p dfe-analytics` and PR that.
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).