Skip to content

Commit c8dd66a

Browse files
lwjohnst86signekbpre-commit-ci[bot]
authored
refactor: ♻️ expand on explanation of release process (#229)
# Description Just to match what we've written in other projects. Needs a quick review. ## Checklist - [x] Ran `just run-all` --------- Co-authored-by: Signe Kirk Brødbæk <signebroedbaek@gmail.com> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
1 parent ef639d7 commit c8dd66a

2 files changed

Lines changed: 94 additions & 69 deletions

File tree

CHANGELOG.md

Lines changed: 81 additions & 63 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,21 @@
11
# Changelog
22

33
Since we follow [Conventional
4-
Commits](https://decisions.seedcase-project.org/why-conventional-commits),
5-
we're able to automatically create a release with
4+
Commits](https://decisions.seedcase-project.org/why-conventional-commits)
5+
when writing commit messages, we're able to automatically create formal
6+
"releases" of the template based on the commit messages. Releases in the
7+
context of template are when changes occur to the `template/` files or
8+
to the `copier.yaml` files. The releases are also published to Zenodo
9+
for easier discovery, archival, and citation purposes. We use
610
[Commitizen](https://decisions.seedcase-project.org/why-semantic-release-with-commitizen)
7-
based on the commit messages. This means that releases can happen quite
8-
often, sometimes several in a day. It also means any individual release
9-
will not have many changes within it. Below is a list of releases along
10-
with what was changed within it.
11+
to be able to automatically create these releases, which uses
12+
[SemVar](https://semverdoc.org) as the version numbering scheme.
13+
14+
Because releases are created based on commit messages, we release quite
15+
often, sometimes several times in a day. This also means that any
16+
individual release will not have many changes within it. Below is a list
17+
of the releases we've made so far, along with what was changed within
18+
each release.
1119

1220
## 0.17.11 (2026-01-15)
1321

@@ -23,154 +31,164 @@ with what was changed within it.
2331

2432
### Fix
2533

26-
- :bug: overwrite `_contributor.qmd` with `>` (#207)
34+
- :bug: overwrite `_contributor.qmd` with `>` (#207)
2735

2836
### Refactor
2937

30-
- :arrow_up: upgrade pre-commit hook versions (#208)
38+
- :arrow_up: upgrade pre-commit hook versions (#208)
3139

3240
## 0.17.9 (2025-09-10)
3341

3442
### Refactor
3543

36-
- :pencil2: use `update`, not `add` for Quarto extension (#195)
44+
- :pencil2: use `update`, not `add` for Quarto extension (#195)
3745

3846
## 0.17.8 (2025-09-08)
3947

4048
### Fix
4149

42-
- :hammer: ignore other dirs and files when listing todos (#200)
43-
- :bug: `github_repo` (via `_folder_name`) doesn't work using `update` (#197)
50+
- :hammer: ignore other dirs and files when listing todos (#200)
51+
- :bug: `github_repo` (via `_folder_name`) doesn't work using `update`
52+
(#197)
4453

4554
### Refactor
4655

47-
- :pushpin: update pre-commit hook versions (#199)
48-
- :memo: simplify CHANGELOG description (#193)
49-
- :hammer: contributor script outputs text, output to file with justfile (#192)
50-
- :fire: `update-from-workflow` is too complicated and not needed (#190)
56+
- :pushpin: update pre-commit hook versions (#199)
57+
- :memo: simplify CHANGELOG description (#193)
58+
- :hammer: contributor script outputs text, output to file with
59+
justfile (#192)
60+
- :fire: `update-from-workflow` is too complicated and not needed
61+
(#190)
5162

5263
## 0.17.7 (2025-09-05)
5364

5465
### Refactor
5566

56-
- :memo: simplify PR template (#196)
67+
- :memo: simplify PR template (#196)
5768

5869
## 0.17.6 (2025-09-05)
5970

6071
### Refactor
6172

62-
- :truck: rename to `check-python`, not `build` (#189)
73+
- :truck: rename to `check-python`, not `build` (#189)
6374

6475
## 0.17.5 (2025-09-02)
6576

6677
### Refactor
6778

68-
- :wrench: can render everything in Quarto project (#183)
79+
- :wrench: can render everything in Quarto project (#183)
6980

7081
## 0.17.4 (2025-09-02)
7182

7283
### Refactor
7384

74-
- :wrench: add more items to sidebar, like overview (#182)
85+
- :wrench: add more items to sidebar, like overview (#182)
7586

7687
## 0.17.3 (2025-09-02)
7788

7889
### Refactor
7990

80-
- :recycle: create homepage as variable, not question (#179)
91+
- :recycle: create homepage as variable, not question (#179)
8192

8293
## 0.17.2 (2025-09-02)
8394

8495
### Refactor
8596

86-
- :hammer: ignore `justfile` when listing TODO items (#181)
97+
- :hammer: ignore `justfile` when listing TODO items (#181)
8798

8899
## 0.17.1 (2025-09-02)
89100

90101
### Refactor
91102

92-
- :recycle: need `date-released` in `CITATION.cff` (#180)
103+
- :recycle: need `date-released` in `CITATION.cff` (#180)
93104

94105
## 0.17.0 (2025-09-02)
95106

96107
### Feat
97108

98-
- :sparkles: add CHANGELOG with some description of it (#178)
109+
- :sparkles: add CHANGELOG with some description of it (#178)
99110

100111
## 0.16.6 (2025-09-02)
101112

102113
### Refactor
103114

104-
- :recycle: delete whole references folder pre and post render (#142)
115+
- :recycle: delete whole references folder pre and post render (#142)
105116

106117
## 0.16.5 (2025-09-01)
107118

108119
### Refactor
109120

110-
- :truck: move GoatCounter file into `docs/includes/` (#177)
121+
- :truck: move GoatCounter file into `docs/includes/` (#177)
111122

112123
## 0.16.4 (2025-09-01)
113124

114125
### Refactor
115126

116-
- :pushpin: update pre-commit versions (#171)
127+
- :pushpin: update pre-commit versions (#171)
117128

118129
## 0.16.3 (2025-09-01)
119130

120131
### Refactor
121132

122-
- :hammer: use `--upgrade` when installing Python dependencies (#174)
133+
- :hammer: use `--upgrade` when installing Python dependencies (#174)
123134

124135
## 0.16.2 (2025-09-01)
125136

126137
### Refactor
127138

128-
- :wrench: add `theme` option in `_quarto.yml`, and `brand` for Seedcase (#170)
139+
- :wrench: add `theme` option in `_quarto.yml`, and `brand` for
140+
Seedcase (#170)
129141

130142
## 0.16.1 (2025-09-01)
131143

132144
### Refactor
133145

134-
- :technologist: simplify the pull request template (#165)
146+
- :technologist: simplify the pull request template (#165)
135147

136148
## 0.16.0 (2025-08-26)
137149

138150
### Feat
139151

140-
- :sparkles: add `update-from-template` workflow (#134)
141-
- :sparkles: add hosting provider variable (#153)
142-
- :memo: add Conduct, Contributing, and filled out README (#131)
143-
- :sparkles: add 404 page to template (#141)
144-
- :sparkles: add files with copier variables (#127)
145-
- :sparkles: copy over static files to template folder (#117)
146-
- :hammer: gitleaks pre-commit to check for credentials (#100)
147-
- :sparkles: add mypy to VS Code settings and extensions (#93)
148-
- :sparkles: add examples section to docstring template (#39)
149-
- 🧑‍💻 add recipe `add-function` (#2)
152+
- :sparkles: add `update-from-template` workflow (#134)
153+
- :sparkles: add hosting provider variable (#153)
154+
- :memo: add Conduct, Contributing, and filled out README (#131)
155+
- :sparkles: add 404 page to template (#141)
156+
- :sparkles: add files with copier variables (#127)
157+
- :sparkles: copy over static files to template folder (#117)
158+
- :hammer: gitleaks pre-commit to check for credentials (#100)
159+
- :sparkles: add mypy to VS Code settings and extensions (#93)
160+
- :sparkles: add examples section to docstring template (#39)
161+
- 🧑‍💻 add recipe `add-function` (#2)
150162

151163
### Fix
152164

153-
- :bug: need to run build workflow after version bump to get changelog (#110)
154-
- :construction_worker: explicitly checkout newest version to publish (#107)
155-
- :construction_worker: forgot to checkout before building and publishing (#106)
156-
- :construction_worker: only run when previous and current versions are different (#98)
157-
- :construction_worker: use the `has_released` output to run or not (#97)
158-
- :bug: install uv in publish step and only for tags (#96)
159-
- :hammer: the `check-commits` recipe wasn't correctly checking them (#48)
160-
- :hammer: the `check-commits` recipe wasn't correctly checking them
161-
- :bug: remove auto-built reference docs before/after building (#47)
162-
- :bug: remove auto-built reference docs before/after building
163-
- :fire: remove django debugger (#44)
164-
- add `test-python` to `run-all` (#38)
165-
- :hammer: update test snippet to given, when, then (#29)
166-
167-
### Refactor
168-
169-
- :recycle: specify svg for all badges (#157)
170-
- :recycle: move copier test to own file (#156)
171-
- :recycle: update post-copy message (#154)
172-
- :recycle: match copier vars in `template-website` (#152)
173-
- :recycle: use `bash` for `check-commits` justfile recipe (#150)
174-
- :wrench: include `github-actions` in dependabot config (#136)
175-
- :construction_worker: move `uv build` step into publish job (#101)
176-
- :recycle: make mypy more strict in settings (#94)
165+
- :bug: need to run build workflow after version bump to get changelog
166+
(#110)
167+
- :construction_worker: explicitly checkout newest version to publish
168+
(#107)
169+
- :construction_worker: forgot to checkout before building and
170+
publishing (#106)
171+
- :construction_worker: only run when previous and current versions
172+
are different (#98)
173+
- :construction_worker: use the `has_released` output to run or not
174+
(#97)
175+
- :bug: install uv in publish step and only for tags (#96)
176+
- :hammer: the `check-commits` recipe wasn't correctly checking them
177+
(#48)
178+
- :hammer: the `check-commits` recipe wasn't correctly checking them
179+
- :bug: remove auto-built reference docs before/after building (#47)
180+
- :bug: remove auto-built reference docs before/after building
181+
- :fire: remove django debugger (#44)
182+
- add `test-python` to `run-all` (#38)
183+
- :hammer: update test snippet to given, when, then (#29)
184+
185+
### Refactor
186+
187+
- :recycle: specify svg for all badges (#157)
188+
- :recycle: move copier test to own file (#156)
189+
- :recycle: update post-copy message (#154)
190+
- :recycle: match copier vars in `template-website` (#152)
191+
- :recycle: use `bash` for `check-commits` justfile recipe (#150)
192+
- :wrench: include `github-actions` in dependabot config (#136)
193+
- :construction_worker: move `uv build` step into publish job (#101)
194+
- :recycle: make mypy more strict in settings (#94)

template/CHANGELOG.md

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,17 @@
11
# Changelog
22

33
Since we follow [Conventional
4-
Commits](https://decisions.seedcase-project.org/why-conventional-commits),
5-
we're able to automatically create a release with
4+
Commits](https://decisions.seedcase-project.org/why-conventional-commits)
5+
when writing commit messages, we're able to automatically create formal
6+
releases of the Python package based on the commit messages. The
7+
releases are also published to Zenodo for easier discovery, archival,
8+
and citation purposes. We use
69
[Commitizen](https://decisions.seedcase-project.org/why-semantic-release-with-commitizen)
7-
based on the commit messages. This means that releases can happen quite
8-
often, sometimes several in a day. It also means any individual release
9-
will not have many changes within it. Below is a list of releases along
10-
with what was changed within it.
10+
to be able to automatically create these releases, which uses
11+
[SemVar](https://semverdoc.org) as the version numbering scheme.
12+
13+
Because releases are created based on commit messages, we release quite
14+
often, sometimes several times in a day. This also means that any
15+
individual release will not have many changes within it. Below is a list
16+
of the releases we've made so far, along with what was changed within
17+
each release.

0 commit comments

Comments
 (0)