Skip to content

Commit e9a3ff3

Browse files
committed
style: 🎨 reformat Markdown with rumdl
1 parent b062026 commit e9a3ff3

11 files changed

Lines changed: 222 additions & 204 deletions

CHANGELOG.md

Lines changed: 59 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Changelog
22

3-
Since we follow [Conventional
4-
Commits](https://decisions.seedcase-project.org/why-conventional-commits)
3+
Since we follow
4+
[Conventional Commits](https://decisions.seedcase-project.org/why-conventional-commits)
55
when writing commit messages, we're able to automatically create formal
66
"releases" of the template based on the commit messages. Releases in the
77
context of template are when changes occur to the `template/` files or
@@ -37,164 +37,164 @@ each release.
3737

3838
### Fix
3939

40-
- :bug: overwrite `_contributor.qmd` with `>` (#207)
40+
- :bug: overwrite `_contributor.qmd` with `>` (#207)
4141

4242
### Refactor
4343

44-
- :arrow_up: upgrade pre-commit hook versions (#208)
44+
- :arrow_up: upgrade pre-commit hook versions (#208)
4545

4646
## 0.17.9 (2025-09-10)
4747

4848
### Refactor
4949

50-
- :pencil2: use `update`, not `add` for Quarto extension (#195)
50+
- :pencil2: use `update`, not `add` for Quarto extension (#195)
5151

5252
## 0.17.8 (2025-09-08)
5353

5454
### Fix
5555

56-
- :hammer: ignore other dirs and files when listing todos (#200)
57-
- :bug: `github_repo` (via `_folder_name`) doesn't work using `update`
56+
- :hammer: ignore other dirs and files when listing todos (#200)
57+
- :bug: `github_repo` (via `_folder_name`) doesn't work using `update`
5858
(#197)
5959

6060
### Refactor
6161

62-
- :pushpin: update pre-commit hook versions (#199)
63-
- :memo: simplify CHANGELOG description (#193)
64-
- :hammer: contributor script outputs text, output to file with
62+
- :pushpin: update pre-commit hook versions (#199)
63+
- :memo: simplify CHANGELOG description (#193)
64+
- :hammer: contributor script outputs text, output to file with
6565
justfile (#192)
66-
- :fire: `update-from-workflow` is too complicated and not needed
66+
- :fire: `update-from-workflow` is too complicated and not needed
6767
(#190)
6868

6969
## 0.17.7 (2025-09-05)
7070

7171
### Refactor
7272

73-
- :memo: simplify PR template (#196)
73+
- :memo: simplify PR template (#196)
7474

7575
## 0.17.6 (2025-09-05)
7676

7777
### Refactor
7878

79-
- :truck: rename to `check-python`, not `build` (#189)
79+
- :truck: rename to `check-python`, not `build` (#189)
8080

8181
## 0.17.5 (2025-09-02)
8282

8383
### Refactor
8484

85-
- :wrench: can render everything in Quarto project (#183)
85+
- :wrench: can render everything in Quarto project (#183)
8686

8787
## 0.17.4 (2025-09-02)
8888

8989
### Refactor
9090

91-
- :wrench: add more items to sidebar, like overview (#182)
91+
- :wrench: add more items to sidebar, like overview (#182)
9292

9393
## 0.17.3 (2025-09-02)
9494

9595
### Refactor
9696

97-
- :recycle: create homepage as variable, not question (#179)
97+
- :recycle: create homepage as variable, not question (#179)
9898

9999
## 0.17.2 (2025-09-02)
100100

101101
### Refactor
102102

103-
- :hammer: ignore `justfile` when listing TODO items (#181)
103+
- :hammer: ignore `justfile` when listing TODO items (#181)
104104

105105
## 0.17.1 (2025-09-02)
106106

107107
### Refactor
108108

109-
- :recycle: need `date-released` in `CITATION.cff` (#180)
109+
- :recycle: need `date-released` in `CITATION.cff` (#180)
110110

111111
## 0.17.0 (2025-09-02)
112112

113113
### Feat
114114

115-
- :sparkles: add CHANGELOG with some description of it (#178)
115+
- :sparkles: add CHANGELOG with some description of it (#178)
116116

117117
## 0.16.6 (2025-09-02)
118118

119119
### Refactor
120120

121-
- :recycle: delete whole references folder pre and post render (#142)
121+
- :recycle: delete whole references folder pre and post render (#142)
122122

123123
## 0.16.5 (2025-09-01)
124124

125125
### Refactor
126126

127-
- :truck: move GoatCounter file into `docs/includes/` (#177)
127+
- :truck: move GoatCounter file into `docs/includes/` (#177)
128128

129129
## 0.16.4 (2025-09-01)
130130

131131
### Refactor
132132

133-
- :pushpin: update pre-commit versions (#171)
133+
- :pushpin: update pre-commit versions (#171)
134134

135135
## 0.16.3 (2025-09-01)
136136

137137
### Refactor
138138

139-
- :hammer: use `--upgrade` when installing Python dependencies (#174)
139+
- :hammer: use `--upgrade` when installing Python dependencies (#174)
140140

141141
## 0.16.2 (2025-09-01)
142142

143143
### Refactor
144144

145-
- :wrench: add `theme` option in `_quarto.yml`, and `brand` for
145+
- :wrench: add `theme` option in `_quarto.yml`, and `brand` for
146146
Seedcase (#170)
147147

148148
## 0.16.1 (2025-09-01)
149149

150150
### Refactor
151151

152-
- :technologist: simplify the pull request template (#165)
152+
- :technologist: simplify the pull request template (#165)
153153

154154
## 0.16.0 (2025-08-26)
155155

156156
### Feat
157157

158-
- :sparkles: add `update-from-template` workflow (#134)
159-
- :sparkles: add hosting provider variable (#153)
160-
- :memo: add Conduct, Contributing, and filled out README (#131)
161-
- :sparkles: add 404 page to template (#141)
162-
- :sparkles: add files with copier variables (#127)
163-
- :sparkles: copy over static files to template folder (#117)
164-
- :hammer: gitleaks pre-commit to check for credentials (#100)
165-
- :sparkles: add mypy to VS Code settings and extensions (#93)
166-
- :sparkles: add examples section to docstring template (#39)
167-
- 🧑‍💻 add recipe `add-function` (#2)
158+
- :sparkles: add `update-from-template` workflow (#134)
159+
- :sparkles: add hosting provider variable (#153)
160+
- :memo: add Conduct, Contributing, and filled out README (#131)
161+
- :sparkles: add 404 page to template (#141)
162+
- :sparkles: add files with copier variables (#127)
163+
- :sparkles: copy over static files to template folder (#117)
164+
- :hammer: gitleaks pre-commit to check for credentials (#100)
165+
- :sparkles: add mypy to VS Code settings and extensions (#93)
166+
- :sparkles: add examples section to docstring template (#39)
167+
- 🧑‍💻 add recipe `add-function` (#2)
168168

169169
### Fix
170170

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

CODE_OF_CONDUCT.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,5 +26,5 @@ be reported by opening an issue or contacting one or more of the project
2626
maintainers.
2727

2828
This Code of Conduct is adapted from the Contributor Covenant
29-
(https://contributor-covenant.org), version 1.0.0, available at
30-
https://contributor-covenant.org/version/1/0/0/
29+
(<https://contributor-covenant.org>), version 1.0.0, available at
30+
<https://contributor-covenant.org/version/1/0/0/>

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,8 @@ integration and delivery workflows, and supporting files for building
2727
robust Python packages.
2828

2929
Check out our
30-
[website](https://template-python-package.seedcase-project.org/) for
31-
more information, such as the features it provides and a
30+
[website](https://template-python-package.seedcase-project.org) for more
31+
information, such as the features it provides and a
3232
[guide](https://template-python-package.seedcase-project.org/docs/guide/)
3333
to using the template. For a list of changes, see our
3434
[changelog](https://template-python-package.seedcase-project.org/docs/releases/)

README.qmd

Lines changed: 9 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -18,24 +18,21 @@ configurations for tools that improve developer experience, continuous
1818
integration and delivery workflows, and supporting files for building
1919
robust Python packages.
2020

21-
Check out our
22-
[website](https://{{< meta gh.repo >}}.{{< meta gh.org >}}.org/) for
23-
more information, such as the features it provides and a
24-
[guide](https://{{< meta gh.repo >}}.{{< meta gh.org >}}.org/docs/guide/)
25-
to using the template. For a list of changes, see our
26-
[changelog](https://{{< meta gh.repo >}}.{{< meta gh.org >}}.org/docs/releases/)
27-
page.
21+
Check out our [website]({{< meta links.site >}}) for more information,
22+
such as the features it provides and a
23+
[guide]({{< meta links.site >}}/docs/guide/) to using the template. For
24+
a list of changes, see our
25+
[changelog]({{< meta links.site >}}/docs/releases/) page.
2826

2927
## Contributing
3028

31-
Check out our [contributing
32-
page](https://{{< meta gh.repo >}}.{{< meta gh.org >}}.org/contributing/)
29+
Check out our [contributing page]({{< meta links.site >}}/contributing/)
3330
for information on how to contribute to the project, including how to
3431
set up your development environment.
3532

36-
Please note that this project is released with a [Contributor Code of
37-
Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree
38-
to abide by its terms.
33+
Please note that this project is released with a
34+
[Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in
35+
this project you agree to abide by its terms.
3936

4037
### Contributors
4138

_metadata.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,3 +6,7 @@ gh:
66
titles:
77
full: "Template Python Package: An opinionated setup for making Python packages"
88
short: "Template Python Package"
9+
10+
links:
11+
github: "https://github.com/seedcase-project/template-python-package"
12+
site: "https://template-python-package.seedcase-project.org"

docs/guide.qmd

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -10,19 +10,19 @@ post-creation tasks.
1010

1111
In order to use this template, you need to install a few programs:
1212

13-
- [Python](https://www.python.org/): Required by the template tool
14-
itself (copier) and for installing and using many of the tools in
15-
this template.
16-
- [Git](https://git-scm.com/): For version control and setting up Git
17-
to track the newly created package.
18-
- [copier](https://copier.readthedocs.io/en/stable/#quick-start): A
19-
template tool for making new projects in a standardised and
20-
structured way.
21-
- [uv](https://docs.astral.sh/uv/): A tool for managing Python
22-
environments and running commands. Some post-copy steps of this
23-
template use uv.
24-
- [just](https://just.systems/man/en/): A build management tool that
25-
helps with running common build and check tasks.
13+
- [Python](https://www.python.org/): Required by the template tool
14+
itself (copier) and for installing and using many of the tools in this
15+
template.
16+
- [Git](https://git-scm.com/): For version control and setting up Git to
17+
track the newly created package.
18+
- [copier](https://copier.readthedocs.io/en/stable/#quick-start): A
19+
template tool for making new projects in a standardised and structured
20+
way.
21+
- [uv](https://docs.astral.sh/uv/): A tool for managing Python
22+
environments and running commands. Some post-copy steps of this
23+
template use uv.
24+
- [just](https://just.systems/man/en/): A build management tool that
25+
helps with running common build and check tasks.
2626

2727
You will need to install Python and Git yourself, but the other tools
2828
can be installed using
@@ -163,23 +163,23 @@ Some configuration is needed after copying this template to a new
163163
repository, including configuration external to the repository. Some
164164
GitHub workflows require installing GitHub Apps, for greater security
165165
purposes and easier administration when managing multiple repositories.
166-
The [security
167-
section](https://guidebook.seedcase-project.org/operations/security#using-github-apps-to-generate-tokens)
166+
The
167+
[security section](https://guidebook.seedcase-project.org/operations/security#using-github-apps-to-generate-tokens)
168168
in our [Guidebook](https://guidebook.seedcase-project.org/) provides
169169
instructions on how to set up GitHub Apps, secrets, and variables.
170170
Ideally the secrets and variables should be set up in the organization
171171
settings. The specific workflows in this template that require this
172172
additional setup are:
173173

174-
- The workflow `.github/workflows/release-package.yml` requires the
175-
[auto-release-token](https://github.com/apps/auto-release-token)
176-
GitHub App as well as a creating a GitHub secret called
177-
`UPDATE_VERSION_TOKEN` and a variable called `UPDATE_VERSION_APP_ID`
178-
that has the App ID.
179-
- The workflow `.github/workflows/add-to-project.yml` requires the
180-
[add-to-board-token](https://github.com/apps/add-to-board-token)
181-
GitHub App, along with the `ADD_TO_BOARD_TOKEN` secret and the
182-
`ADD_TO_BOARD_APP_ID` variable of the GitHub App's ID.
174+
- The workflow `.github/workflows/release-package.yml` requires the
175+
[auto-release-token](https://github.com/apps/auto-release-token)
176+
GitHub App as well as a creating a GitHub secret called
177+
`UPDATE_VERSION_TOKEN` and a variable called `UPDATE_VERSION_APP_ID`
178+
that has the App ID.
179+
- The workflow `.github/workflows/add-to-project.yml` requires the
180+
[add-to-board-token](https://github.com/apps/add-to-board-token)
181+
GitHub App, along with the `ADD_TO_BOARD_TOKEN` secret and the
182+
`ADD_TO_BOARD_APP_ID` variable of the GitHub App's ID.
183183

184184
If you use Netlify, you will also need to add a `NETLIFY_AUTH_TOKEN`
185185
secret of your Netlify Token.

0 commit comments

Comments
 (0)