Skip to content

Commit

Permalink
📃docs: add #1 as known issue
Browse files Browse the repository at this point in the history
  • Loading branch information
zillionare committed Apr 20, 2021
1 parent 15d1d30 commit 0de1fa3
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 1 deletion.
24 changes: 24 additions & 0 deletions docs/faq.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,27 @@
???+ Question
# Why github workflow `release & publish` failed?
We have used a github action `heinrichreimer/github-changelog-generator-action` to
generate change log automatically for your project. However, this action requires
some configuration.

Goto .github/workflows/release.yml (in your project folder), find the following:
```
- name: generate change log
uses: heinrichreimer/[email protected]
with:
token: ${{ secrets.GITHUB_TOKEN }}
issues: true
issuesWoLabels: true
pullRequests: true
prWoLabels: true
unreleased: true
addSections: '{"documentation":{"prefix":"**Documentation:**","labels":["documentation"]}}'
#sinceTag: v0.1.1
output: CHANGELOG.md
```
uncomment `#sinceTag` line and given an existed tag name in your project. If
there's none, you have to create one now.

???+ Question
# Why not travis CI?
Travis CI is a great service, however, github actions is super convenient, less configuration
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[tool]
[tool.poetry]
name = "ppw"
version = "1.0.0-alpha.0"
version = "1.0.0-alpha.1"
description = "A Wizard to create a skeleton python project with up-to-date technology"
license = "BSD-3-Clause"
authors = ["Aaron Yang <[email protected]>"]
Expand Down

0 comments on commit 0de1fa3

Please sign in to comment.