Skip to content

Commit 5add95b

Browse files
themightychristhemightychris
authored
Merge pull request #38 from CodeForPhilly/develop
Release: v0.1.3
2 parents 74f6945 + 4515da8 commit 5add95b

29 files changed

+882
-59
lines changed

‎.holo/branches/helm-chart/_third-places.toml‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
[holomapping]
2+
root = "helm-chart"
3+
files = "**"

‎.holo/config.toml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
[holospace]
2+
name = "third-places"

‎CHANGELOG.md‎

Lines changed: 39 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,25 +3,57 @@
33
All notable changes to this project will be documented in this file.
44

55
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6-
and this project adheres to release number versioning.
6+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
77

88
## [Unreleased]
99

1010
### Added
1111

12-
- Set up React and Django boilerplate [#1](https://github.com/CodeForPhilly/third-places/pull/1)
13-
- Added Docker containers with docker-compose [#10](https://github.com/CodeForPhilly/third-places/pull/10)
14-
- Set up Leaflet React component and boiletplate homepage[#7](https://github.com/CodeForPhilly/third-places/issues/7)
15-
- Added initial Django models & migration [#21](https://github.com/CodeForPhilly/third-places/pull/21)
12+
- Added initial REST endpoints for Users [#23](https://github.com/CodeForPhilly/third-places/pull/23)
13+
- Added buttons at bottom of Map [#40](https://github.com/CodeForPhilly/third-places/pull/40)
14+
- Add location endpoints [#44](https://github.com/CodeForPhilly/third-places/pull/44)
15+
- Add migration to populate locations from Yelp [#48](https://github.com/CodeForPhilly/third-places/pull/48)
1616

1717
### Changed
1818

19+
- Update docs with release process [#40](https://github.com/CodeForPhilly/third-places/pull/40)
20+
1921
### Deprecated
2022

2123
### Removed
2224

2325
### Fixed
24-
- Issue template [#9](https://github.com/CodeForPhilly/third-places/pull/9)
2526

27+
## [0.1.2]
28+
29+
### Fixed
30+
31+
- Remove nonexistent target [#37](https://github.com/CodeForPhilly/third-places/pull/37)
32+
33+
## [0.1.1]
34+
35+
### Added
36+
37+
- Build and publish Docker container images [#36](https://github.com/CodeForPhilly/third-places/pull/36)
38+
39+
## [0.1.0]
40+
41+
### Added
42+
43+
- Set up React and Django boilerplate [#1](https://github.com/CodeForPhilly/third-places/pull/1)
44+
- Added Docker containers with docker-compose [#10](https://github.com/CodeForPhilly/third-places/pull/10)
45+
- Set up Leaflet React component and boiletplate homepage[#16](https://github.com/CodeForPhilly/third-places/issues/16)
46+
- Added initial Django models & migration [#21](https://github.com/CodeForPhilly/third-places/pull/21)
47+
- Add automated release workflow [#35](https://github.com/CodeForPhilly/third-places/pull/35)
48+
49+
### Changed
50+
51+
- Made Leaflet map element fullscreen and rmeoved title[#27](https://github.com/CodeForPhilly/third-places/issues/27)
52+
53+
### Fixed
54+
55+
- Issue template [#9](https://github.com/CodeForPhilly/third-places/pull/9)
2656

27-
[Unreleased]:
57+
[0.1.3]: https://github.com/CodeForPhilly/third-places/compare/v0.1.1...v0.1.2
58+
[0.1.1]: https://github.com/CodeForPhilly/third-places/compare/v0.1.0...v0.1.1
59+
[0.1.0]: https://github.com/CodeForPhilly/third-places/releases/tag/v0.1.0

‎CONTRIBUTING.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -160,3 +160,7 @@ git pull
160160
# Delete the branch from your local machine
161161
git branch -d <new-branch-name>
162162
```
163+
164+
## Creating a release
165+
166+
See the [RELEASES.md](https://github.com/CodeForPhilly/third-places/blob/develop/RELEASES.md) for an explanation of this process

‎README.md‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,4 +67,6 @@ Access the following ports from localhost to access their respective services
6767

6868
### Api Reference
6969

70-
`/api/`: Hello world!
70+
- `/api/`: Hello world!
71+
- `/users/`: `GET`, `POST` users
72+
- `/users/{id}`: `GET`, `PUT` specific user details

‎RELEASES.md‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# Releases
2+
3+
## Overview
4+
5+
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.
6+
7+
## Creating a release
8+
9+
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:
10+
- Find the automated PR that was created by github-actions.
11+
- It will always have a "Release: v#.#.#" title.
12+
- Copy the list from the "changelog" comment
13+
- Edit the description of the release PR
14+
- Paste in the list of changes and distribute each item accordingly to the Improvements and Technical sections
15+
- Update `CHANGELOG.md` as part of the release PR:
16+
- Copy the whole "Unreleased" section and paste above it
17+
- Replace the lower "Unreleased" title with the version in the release PR
18+
- In the top unreleased section remove all references from each of the five lists (reset it to be blank)
19+
- 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)
20+
- At the very bottom there is a list of the versions.
21+
- Copy the top version list line and paste it at the top of the same list
22+
- Change the numbers to now reflect this change
23+
- Merge the PR to main
24+
- This will kick off a continuous
25+
26+
### Note
27+
28+
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.
29+
30+
## Updating the CHANGELOG.md
31+
32+
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.
33+
34+
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.

‎helm-chart/.helmignore‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Patterns to ignore when building packages.
2+
# This supports shell glob matching, relative path matching, and
3+
# negation (prefixed with !). Only one pattern per line.
4+
.DS_Store
5+
# Common VCS dirs
6+
.git/
7+
.gitignore
8+
.bzr/
9+
.bzrignore
10+
.hg/
11+
.hgignore
12+
.svn/
13+
# Common backup files
14+
*.swp
15+
*.bak
16+
*.tmp
17+
*.orig
18+
*~
19+
# Various IDEs
20+
.project
21+
.idea/
22+
*.tmproj
23+
.vscode/

‎helm-chart/Chart.yaml‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
apiVersion: v2
2+
name: third-places
3+
description: A Helm chart for Kubernetes
4+
5+
# A chart can be either an 'application' or a 'library' chart.
6+
#
7+
# Application charts are a collection of templates that can be packaged into versioned archives
8+
# to be deployed.
9+
#
10+
# Library charts provide useful utilities or functions for the chart developer. They're included as
11+
# a dependency of application charts to inject those utilities and functions into the rendering
12+
# pipeline. Library charts do not define any templates and therefore cannot be deployed.
13+
type: application
14+
15+
# This is the chart version. This version number should be incremented each time you make changes
16+
# to the chart and its templates, including the app version.
17+
# Versions are expected to follow Semantic Versioning (https://semver.org/)
18+
version: 0.1.0
19+
20+
# This is the version number of the application being deployed. This version number should be
21+
# incremented each time you make changes to the application. Versions are not expected to
22+
# follow Semantic Versioning. They should reflect the version the application is using.
23+
# It is recommended to use it with quotes.
24+
appVersion: 0.1.2

‎helm-chart/templates/_helpers.tpl‎

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
{{/*
2+
Expand the name of the chart.
3+
*/}}
4+
{{- define "third-places.name" -}}
5+
{{- default .Chart.Name .Values.nameOverride | trunc 63 | trimSuffix "-" }}
6+
{{- end }}
7+
8+
{{/*
9+
Create a default fully qualified app name.
10+
We truncate at 63 chars because some Kubernetes name fields are limited to this (by the DNS naming spec).
11+
If release name contains chart name it will be used as a full name.
12+
*/}}
13+
{{- define "third-places.fullname" -}}
14+
{{- if .Values.fullnameOverride }}
15+
{{- .Values.fullnameOverride | trunc 63 | trimSuffix "-" }}
16+
{{- else }}
17+
{{- $name := default .Chart.Name .Values.nameOverride }}
18+
{{- if contains $name .Release.Name }}
19+
{{- .Release.Name | trunc 63 | trimSuffix "-" }}
20+
{{- else }}
21+
{{- printf "%s-%s" .Release.Name $name | trunc 63 | trimSuffix "-" }}
22+
{{- end }}
23+
{{- end }}
24+
{{- end }}
25+
26+
{{/*
27+
Create chart name and version as used by the chart label.
28+
*/}}
29+
{{- define "third-places.chart" -}}
30+
{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" }}
31+
{{- end }}
32+
33+
{{/*
34+
Common labels
35+
*/}}
36+
{{- define "third-places.labels" -}}
37+
helm.sh/chart: {{ include "third-places.chart" . }}
38+
{{ include "third-places.selectorLabels" . }}
39+
{{- if .Chart.AppVersion }}
40+
app.kubernetes.io/version: {{ .Chart.AppVersion | quote }}
41+
{{- end }}
42+
app.kubernetes.io/managed-by: {{ .Release.Service }}
43+
{{- end }}
44+
45+
{{/*
46+
Selector labels
47+
*/}}
48+
{{- define "third-places.selectorLabels" -}}
49+
app.kubernetes.io/name: {{ include "third-places.name" . }}
50+
app.kubernetes.io/instance: {{ .Release.Name }}
51+
{{- end }}
52+
53+
{{/*
54+
Create the name of the service account to use
55+
*/}}
56+
{{- define "third-places.serviceAccountName" -}}
57+
{{- if .Values.serviceAccount.create }}
58+
{{- default (include "third-places.fullname" .) .Values.serviceAccount.name }}
59+
{{- else }}
60+
{{- default "default" .Values.serviceAccount.name }}
61+
{{- end }}
62+
{{- end }}

‎helm-chart/templates/database/service.yaml‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
apiVersion: v1
2+
kind: Service
3+
metadata:
4+
name: {{ include "third-places.fullname" . }}-postgresql
5+
labels:
6+
{{- include "third-places.labels" . | nindent 4 }}
7+
app.kubernetes.io/component: postgresql
8+
spec:
9+
selector:
10+
{{- include "third-places.selectorLabels" . | nindent 4 }}
11+
app.kubernetes.io/component: postgresql
12+
type: {{ .Values.postgresql.serviceType }}
13+
ports:
14+
- name: postgresql
15+
port: 5432
16+
nodePort: 30432

0 commit comments

Comments
 (0)