Skip to content

Commit 0de1fa3

Browse files
committed
📃docs: add #1 as known issue
1 parent 15d1d30 commit 0de1fa3

File tree

2 files changed

+25
-1
lines changed

2 files changed

+25
-1
lines changed

docs/faq.md

+24
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,27 @@
1+
???+ Question
2+
# Why github workflow `release & publish` failed?
3+
We have used a github action `heinrichreimer/github-changelog-generator-action` to
4+
generate change log automatically for your project. However, this action requires
5+
some configuration.
6+
7+
Goto .github/workflows/release.yml (in your project folder), find the following:
8+
```
9+
- name: generate change log
10+
uses: heinrichreimer/github-changelog-generator-action@v2.1.1
11+
with:
12+
token: ${{ secrets.GITHUB_TOKEN }}
13+
issues: true
14+
issuesWoLabels: true
15+
pullRequests: true
16+
prWoLabels: true
17+
unreleased: true
18+
addSections: '{"documentation":{"prefix":"**Documentation:**","labels":["documentation"]}}'
19+
#sinceTag: v0.1.1
20+
output: CHANGELOG.md
21+
```
22+
uncomment `#sinceTag` line and given an existed tag name in your project. If
23+
there's none, you have to create one now.
24+
125
???+ Question
226
# Why not travis CI?
327
Travis CI is a great service, however, github actions is super convenient, less configuration

pyproject.toml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
[tool]
22
[tool.poetry]
33
name = "ppw"
4-
version = "1.0.0-alpha.0"
4+
version = "1.0.0-alpha.1"
55
description = "A Wizard to create a skeleton python project with up-to-date technology"
66
license = "BSD-3-Clause"
77
authors = ["Aaron Yang <aaron_yang@jieyu.ai>"]

0 commit comments

Comments
 (0)