diff options
Diffstat (limited to '')
-rw-r--r-- | .github/ISSUE_TEMPLATE/bug_report.md | 18 | ||||
-rw-r--r-- | .github/ISSUE_TEMPLATE/feature_request.md | 20 | ||||
-rw-r--r-- | .github/workflows/python-publish.yml | 23 |
3 files changed, 51 insertions, 10 deletions
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..3884dc0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,18 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: '' +assignees: '' + +--- + +**Before you file an issue** +- Make sure you specify the "read" dialect eg. parse_one(sql, read="spark") +- Check if the issue still exists on main + +**Fully reproducible code snippet** +Please include a fully reproducible code snippet or the input sql, dialect, and expected output. + +**Official Documentation** +Please include links to official SQL documentation related to your issue. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..bbcbbe7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,20 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: '' +assignees: '' + +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here. diff --git a/.github/workflows/python-publish.yml b/.github/workflows/python-publish.yml index 8f7c01c..de63033 100644 --- a/.github/workflows/python-publish.yml +++ b/.github/workflows/python-publish.yml @@ -26,14 +26,17 @@ jobs: run: | python setup.py sdist bdist_wheel twine upload dist/* - - name: Update documentation - run: | - make docs - git add docs - git config --local user.email "41898282+github-actions[bot]@users.noreply.github.com" - git config --local user.name "github-actions[bot]" - git commit -m "CI: Auto-generated documentation" -a | exit 0 - - name: Push changes - uses: ad-m/github-push-action@master + - name: Update API docs + run: make docs + - name: Update CHANGELOG + id: changelog + uses: requarks/changelog-action@v1 + with: + token: ${{ github.token }} + tag: ${{ github.ref_name }} + - name: Commit API docs, CHANGELOG.md + uses: stefanzweifel/git-auto-commit-action@v4 with: - github_token: ${{ secrets.GITHUB_TOKEN }} + branch: main + commit_message: 'docs: update API docs, CHANGELOG.md for ${{ github.ref_name }} [skip ci]' + file_pattern: 'docs CHANGELOG.md' |