diff --git a/docs/faq.md b/docs/faq.md index 5bc294d8..0b3afc86 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -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/github-changelog-generator-action@v2.1.1 + 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 diff --git a/pyproject.toml b/pyproject.toml index 84bc53d3..831a5649 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -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 "]