Skip to content

Commit 0836d8e

Browse files
committed
fix: update readme and tests
Signed-off-by: Frost Ming <me@frostming.com>
1 parent 70d2a08 commit 0836d8e

File tree

4 files changed

+30
-13
lines changed

4 files changed

+30
-13
lines changed

.github/workflows/ci.yml

Lines changed: 20 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,13 @@ on:
44
pull_request:
55
paths-ignore:
66
- 'docs/**'
7-
- 'news/**'
87
- '*.md'
98
push:
109
branches:
1110
- main
12-
paths-ignore:
13-
- 'docs/**'
14-
- 'news/**'
15-
- '*.md'
11+
12+
permissions:
13+
contents: write
1614

1715
jobs:
1816
Testing:
@@ -50,3 +48,20 @@ jobs:
5048
pdm install -d
5149
pdm run test
5250
working-directory: ${{ github.workspace }}/tests/tmp
51+
52+
Release:
53+
needs: Testing
54+
runs-on: ubuntu-latest
55+
if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
56+
steps:
57+
- uses: actions/checkout@v3
58+
with:
59+
fetch-depth: 0
60+
61+
- uses: actions/setup-node@v3
62+
with:
63+
node-version: 16
64+
65+
- run: npx changelogithub
66+
env:
67+
GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}

README.md

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,7 @@ Copier template for PDM projects.
44

55
This copier template is mainly for my own usage, but feel free to try it out, or fork it!
66

7-
Note that this template uses some unreleased features from the HEAD version of Copier, you have to install Copier via the VCS repo:
8-
9-
```bash
10-
$ pipx install git+https://github.com/copier-org/copier.git@master#egg=copier
11-
# OR
12-
$ pip install --user git+https://github.com/copier-org/copier.git@master#egg=copier
13-
```
7+
You need to install [Copier](https://copier.readthedocs.io/en/stable/) first.
148

159
## Features
1610

changelogithub.config.json

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"types": {
3+
"feat": { "title": "🚀 Features" },
4+
"fix": { "title": "🐞 Bug Fixes" },
5+
"doc": { "title": "📝 Documentation" },
6+
"chore": { "title": "💻 Chores" }
7+
}
8+
}

project/tests/test_core.py.jinja

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@ import {{ python_package_import_name }}
22

33

44
def test_import_package():
5-
assert isinstance({{ python_package_import_name }}.__all__, list)
5+
pass

0 commit comments

Comments
 (0)