Skip to content

Commit 7b05ac2

Browse files
committed
Update GitHub project.
* Update badges * Update issue templates * Add CodeQL Analysis
1 parent c7bee98 commit 7b05ac2

File tree

6 files changed

+97
-31
lines changed

6 files changed

+97
-31
lines changed

.github/ISSUE_TEMPLATE.md

Lines changed: 0 additions & 17 deletions
This file was deleted.

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: bug
6+
assignees: ''
7+
8+
---
9+
10+
**Describe the bug**
11+
A clear and concise description of what the bug is.
12+
13+
**To Reproduce**
14+
Please provide a self-contained script to reproduce the bug if possible.
15+
```python
16+
from gino import Gino
17+
18+
db = Gino()
19+
20+
async def main():
21+
async with db.with_bind("postgresql:///"):
22+
...
23+
```
24+
25+
**Expected result**
26+
```
27+
The expected output or behavior of the script (when the bug is fixed).
28+
```
29+
30+
**Actual result**
31+
```
32+
The actual output or behavior of the script (before a bugfix).
33+
```
34+
35+
**Environment (please complete the following information):**
36+
- GINO: [e.g. 1.0.1]
37+
- SQLAlchemy: [e.g. 1.3.10]
38+
- Other: [e.g. Linux, macOS, PostgreSQL 9.6, asyncpg 0.18, aiomysql 0.0.20]
39+
40+
**Additional context**
41+
Add any other context about the problem here.
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: feature request
6+
assignees: ''
7+
8+
---
9+
10+
**Is your feature request related to a problem? Please describe.**
11+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12+
13+
**Describe the solution you'd like**
14+
A clear and concise description of what you want to happen.
15+
16+
**Describe alternatives you've considered**
17+
A clear and concise description of any alternative solutions or features you've considered.
18+
19+
**Additional context**
20+
Add any other context or screenshots about the feature request here.

.github/ISSUE_TEMPLATE/question.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
name: Question
3+
about: Please use GitHub Discussions Q&A instead
4+
title: ''
5+
labels: question
6+
assignees: ''
7+
8+
---
9+
10+
We are stopping to use GitHub Issues for questions, please go to the GitHub [Discussions Q&A](https://github.com/python-gino/gino/discussions?discussions_q=category%3AQ%26A) instead.

.github/workflows/ci.yml

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ on:
1010
branches:
1111
- "master"
1212
- "v[0-9]+.[0-9]+.x"
13+
schedule:
14+
- cron: '24 14 * * 6'
1315

1416
jobs:
1517
create-virtualenv:
@@ -282,3 +284,17 @@ jobs:
282284
env:
283285
SPHINXINTL_TRANSIFEX_USERNAME: api
284286
SPHINXINTL_TRANSIFEX_PASSWORD: ${{ secrets.TRANSIFEX_TOKEN }}
287+
288+
analyze:
289+
runs-on: ubuntu-latest
290+
steps:
291+
- name: source code
292+
uses: actions/checkout@v2
293+
294+
- name: Initialize CodeQL
295+
uses: github/codeql-action/init@v1
296+
with:
297+
languages: python
298+
299+
- name: Perform CodeQL Analysis
300+
uses: github/codeql-action/analyze@v1

README.rst

Lines changed: 10 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -6,26 +6,22 @@
66
:alt: PyPI Release Version
77
:target: https://pypi.python.org/pypi/gino
88

9-
.. image:: https://img.shields.io/github/workflow/status/python-gino/gino/test?label=test&logo=github
10-
:alt: GitHub Workflow Status for tests
11-
:target: https://github.com/python-gino/gino/actions?query=workflow%3Atest
9+
.. image:: https://img.shields.io/pypi/dm/gino?logo=pypi&logoColor=white
10+
:alt: PyPI Monthly Downloads
11+
:target: https://pypi.python.org/pypi/gino
12+
13+
.. image:: https://img.shields.io/github/workflow/status/python-gino/gino/CI?label=CI&logo=github
14+
:alt: GitHub Workflow Status for CI
15+
:target: https://github.com/python-gino/gino/actions?query=workflow%3ACI
1216

13-
.. image:: https://img.shields.io/github/workflow/status/python-gino/gino/docs?label=docs&logo=github
14-
:alt: GitHub Workflow Status for docs
15-
:target: https://python-gino.org/docs/
17+
.. image:: https://img.shields.io/codacy/grade/b6a59cdf5ca64eab9104928d4f9bbb97?logo=codacy
18+
:alt: Codacy Code Quality
19+
:target: https://app.codacy.com/gh/python-gino/gino/dashboard
1620

1721
.. image:: https://img.shields.io/codacy/coverage/b6a59cdf5ca64eab9104928d4f9bbb97?logo=codacy
1822
:alt: Codacy coverage
1923
:target: https://app.codacy.com/gh/python-gino/gino/dashboard
2024

21-
.. image:: https://img.shields.io/badge/Dependabot-active-brightgreen?logo=dependabot
22-
:target: https://app.dependabot.com/accounts/python-gino/projects/129260
23-
:alt: Dependabot
24-
25-
.. image:: https://img.shields.io/gitter/room/python-gino/Lobby?logo=gitter
26-
:target: https://gitter.im/python-gino/Lobby
27-
:alt: Gitter chat
28-
2925

3026
GINO - GINO Is Not ORM - is a lightweight asynchronous ORM built on top of
3127
SQLAlchemy_ core for Python asyncio_. GINO 1.0 supports only PostgreSQL_ with asyncpg_.

0 commit comments

Comments
 (0)