Skip to content

Commit 37ebb64

Browse files
Roll out workflow-based release creation and deployment, automatic release notes, pull request template (#24)
1 parent 441d937 commit 37ebb64

4 files changed

Lines changed: 44 additions & 15 deletions

File tree

.github/pull_request_template.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
2+
### This PR is related to user story DST-
3+
4+
## Description
5+
Provide a short description about the work that has been done.
6+
7+
## Checklist
8+
- [ ] PR title is descriptive and fit for injection into release notes (see tips below)
9+
- [ ] Correct label(s) are used
10+
11+
12+
PR title tips:
13+
* Use imperative mood
14+
* Describe the motivation for change, issue that has been solved or what has been improved - not how
15+
* Examples:
16+
* Add functionality for Allan variance to sensor_4s.simulate
17+
* Upgrade to support Python 9.10
18+
* Remove MacOS from CI
19+
20+

.github/release.yml

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
changelog:
2+
exclude:
3+
labels:
4+
- chore
5+
- test
6+
7+
categories:
8+
- title: Breaking Changes 🛠
9+
labels:
10+
- breaking-change
11+
- title: Features 🎉
12+
labels:
13+
- feature
14+
- enhancement
15+
- title: Bug Fixes 🐛
16+
labels:
17+
- bug
18+
- title: Other Changes ✅
19+
labels:
20+
- documentation
21+
- refactor
22+
- "*"

.github/workflows/deploy_public.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,8 @@ jobs:
8585
if [[ "$inject" == "True" ]] && [[ $i -le $n_tag ]];
8686
then
8787
i=$((i+1))
88-
echo -e "$(gh release view $tag --json name,body --template '{{ .name }}\n------------------------------\n\n{{ .body }}\n\n')" >> docs/release_notes.rst
88+
echo -e "$(gh release view $tag --json name --template '{{.name}}\n------------------------------')" >> docs/release_notes.rst
89+
echo -e "$(gh release view $tag --json body --template '{{.body}}\n')" | sed 's/<!-[^~]*->//g' | sed G >> docs/release_notes.rst
8990
fi
9091
done
9192
echo -e "*Note: this list includes only the most recent releases. For full release history, see www.github.com/$REPO_NAME/releases" >> docs/release_notes.rst

docs/release_notes.rst

Lines changed: 0 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,3 @@
11
Release Notes
22
=============
33

4-
v0.1.3
5-
------
6-
7-
- Update documentation
8-
9-
v0.1.2
10-
------
11-
12-
- fix: issue with re-authenticating when refresh-token expire
13-
14-
v0.1.1
15-
------
16-
17-
- First public release

0 commit comments

Comments
 (0)