Merge pull request #42 from CodeForPhilly/ts/update-docs

Update docs with release process

Author: travissouthard

CHANGELOG.md

@@ -3,27 +3,55 @@
 All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
-and this project adheres to release number versioning.
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
 
 ### Added
 
-- Set up React and Django boilerplate [#1](https://github.com/CodeForPhilly/third-places/pull/1)
-- Added Docker containers with docker-compose [#10](https://github.com/CodeForPhilly/third-places/pull/10)
-- Set up Leaflet React component and boiletplate homepage[#7](https://github.com/CodeForPhilly/third-places/issues/7)
-- Added initial Django models & migration [#21](https://github.com/CodeForPhilly/third-places/pull/21)
 - Added initial REST endpoints for Users [#23](https://github.com/CodeForPhilly/third-places/pull/23)
 - Added buttons at bottom of Map [#40](https://github.com/CodeForPhilly/third-places/pull/40)
 
 ### Changed
-- Made Leaflet map element fullscreen and rmeoved title[#27](https://github.com/CodeForPhilly/third-places/issues/27)
+
+- Update docs with release process [#40](https://github.com/CodeForPhilly/third-places/pull/40)
+
 ### Deprecated
 
 ### Removed
 
 ### Fixed 
-- Issue template [#9](https://github.com/CodeForPhilly/third-places/pull/9)
 
+## [0.1.2]
+
+### Fixed
+
+- Remove nonexistent target [#37](https://github.com/CodeForPhilly/third-places/pull/37)
+
+## [0.1.1]
+
+### Added
+
+- Build and publish Docker container images [#36](https://github.com/CodeForPhilly/third-places/pull/36)
+
+## [0.1.0]
+
+### Added
+
+- Set up React and Django boilerplate [#1](https://github.com/CodeForPhilly/third-places/pull/1)
+- Added Docker containers with docker-compose [#10](https://github.com/CodeForPhilly/third-places/pull/10)
+- Set up Leaflet React component and boiletplate homepage[#16](https://github.com/CodeForPhilly/third-places/issues/16)
+- Added initial Django models & migration [#21](https://github.com/CodeForPhilly/third-places/pull/21)
+- Add automated release workflow [#35](https://github.com/CodeForPhilly/third-places/pull/35)
+
+### Changed
+
+- Made Leaflet map element fullscreen and rmeoved title[#27](https://github.com/CodeForPhilly/third-places/issues/27)
+
+### Fixed 
+
+- Issue template [#9](https://github.com/CodeForPhilly/third-places/pull/9)
 
-[Unreleased]: 
+[0.1.3]: https://github.com/CodeForPhilly/third-places/compare/v0.1.1...v0.1.2
+[0.1.1]: https://github.com/CodeForPhilly/third-places/compare/v0.1.0...v0.1.1
+[0.1.0]: https://github.com/CodeForPhilly/third-places/releases/tag/v0.1.0

CONTRIBUTING.md

@@ -160,3 +160,7 @@ git pull
 # Delete the branch from your local machine
 git branch -d <new-branch-name>
 ```
+
+## Creating a release
+
+See the [RELEASES.md](https://github.com/CodeForPhilly/third-places/blob/develop/RELEASES.md) for an explanation of this process

RELEASES.md

@@ -0,0 +1,34 @@
+# Releases
+
+## Overview
+
+Releases on this project are triggered through GitHub Actions listening for differences between our `main` and `develop` branches. A pull request for the next release is created by a github-actions bot and merging this pull request automatically delivers the changes up to production.
+
+## Creating a release
+
+A release pull request (PR) is created anytime something new is merged to `develop` that has not yet been merged to `main`. To execute a release and kickoff the CI process: 
+- Find the automated PR that was created by github-actions.
+  - It will always have a "Release: v#.#.#" title.
+- Copy the list from the "changelog" comment
+- Edit the description of the release PR
+- Paste in the list of changes and distribute each item accordingly to the Improvements and Technical sections
+- Update `CHANGELOG.md` as part of the release PR:
+  - Copy the whole "Unreleased" section and paste above it
+  - Replace the lower "Unreleased" title with the version in the release PR
+  - In the top unreleased section remove all references from each of the five lists (reset it to be blank)
+  - In the section covering this release's changes, remove any of the sections that have no PRs referenced (e.g. if "Removed" has no PRs in it, you can remove that section title)
+  - At the very bottom there is a list of the versions.
+    - Copy the top version list line and paste it at the top of the same list
+    - Change the numbers to now reflect this change
+- Merge the PR to main
+- This will kick off a continuous 
+
+### Note
+
+Once more PRs are merged to `develop` a new Release PR will be created automatically. We will never have to write a release PR from scratch.
+
+## Updating the CHANGELOG.md
+
+Besides the [version changelog](https://github.com/CodeForPhilly/third-places/releases) that is automatically created as releases are executed, we also keep a [CHANGELOG.md](https://github.com/CodeForPhilly/third-places/blob/develop/CHANGELOG.md) that is updated with each pull request that is merged to develop to help keep track of what changes are made.
+
+The changelog itself links to [documentation](https://keepachangelog.com/en/1.0.0/) describing the format. The essential form is a list of PR titles and links to those PRs organized by what release they go with and what category of change they are making.