Skip to content

Commit 9e0d57f

Browse files
Only-bottleOnly-bottle
committed
Initial setup of project structure and configuration files
1 parent 345e082 commit 9e0d57f

File tree

367 files changed

+26259
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

367 files changed

+26259
-0
lines changed

‎.github/CODEOWNERS‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
* @Only-bottle

‎.github/ISSUE_TEMPLATE/bug_report_template.yml‎

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
# This issue template is modified from https://github.com/gradio-app/gradio/blob/main/.github/ISSUE_TEMPLATE/bug_report_template.yml
2+
name: "\U0001F41E Bug report"
3+
description: Create a report to help us improve
4+
title: "[BUG] Please write your own title"
5+
labels: ["bug"]
6+
assignees:
7+
- Only-bottle
8+
9+
body:
10+
- type: markdown
11+
attributes:
12+
value: |
13+
Thanks for taking the time to fill out this bug report! Before you get started, please search if an issue already exists for the bug you encountered
14+
15+
- type: checkboxes
16+
attributes:
17+
label: Have you searched existing issues? 🔎
18+
description: Please search to see if an issue already exists for the issue you encountered.
19+
options:
20+
- label: I have searched and found no existing issues
21+
required: true
22+
23+
- type: textarea
24+
id: bug-description
25+
attributes:
26+
label: Describe the bug
27+
description: Please provide a concise description.
28+
placeholder: A clear and concise description of what the bug is.
29+
validations:
30+
required: true
31+
32+
- type: textarea
33+
id: reproduction
34+
attributes:
35+
label: Reproduction
36+
description: Please provide a minimal example, with code, that can be run to reproduce the issue. Do NOT provide screenshots of code, or link to external repos or applications. Use ``` to format code blocks.
37+
placeholder: Reproduction
38+
validations:
39+
required: true
40+
41+
- type: textarea
42+
id: screenshot
43+
attributes:
44+
label: Screenshot
45+
description: If relevant, please include screenshot(s) so that we can understand what the issue is.
46+
47+
- type: textarea
48+
id: logs
49+
attributes:
50+
label: Logs
51+
description: Please include the full stacktrace of the errors you get from the code.
52+
render: shell
53+
54+
- type: textarea
55+
id: system-info
56+
attributes:
57+
label: System Info
58+
description: Please ensure that you use the latest version of this package. If you use the customized version of this package, you may fill out the system information in more details.
59+
render: shell
60+
validations:
61+
required: true
62+
63+
- type: checkboxes
64+
attributes:
65+
label: Will you help us by submitting a PR?
66+
options:
67+
- label: I will submit a PR about this issue.
68+
69+
- type: markdown
70+
attributes:
71+
value: |
72+
📌 Please ensure that you have filled all of the required sections above, and that the reproduction you have provided is [minimal, complete, and reproducible](https://stackoverflow.com/help/minimal-reproducible-example). Incomplete issues will be closed.

‎.github/ISSUE_TEMPLATE/feature-request.yml‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
name: "\U0001F3A8 Feature request"
2+
description: Suggest an improvement or new feature for this repository.
3+
title: "[Feature Request] Please write your own title"
4+
labels: ["help wanted"]
5+
assignees: Only-bottle
6+
7+
body:
8+
- type: checkboxes
9+
attributes:
10+
label: Have you searched existing issues? 🔎
11+
options:
12+
- label: I have searched and found no existing issues.
13+
required: true
14+
15+
- type: textarea
16+
id: feture-request
17+
attributes:
18+
label: Is there any feature that you would like to add?
19+
description: Please write a clear and concise description.
20+
validations:
21+
required: true
22+
23+
- type: textarea
24+
id: implement-suggestion
25+
attributes:
26+
label: Is there any suggestion (or solution) to solve this issue?
27+
description: Please write a clear and concise description.
28+
validations:
29+
required: true
30+
31+
- type: textarea
32+
id: additional-context
33+
attributes:
34+
label: Additional context.
35+
description: All other contexts or screenshots are welcome.
36+
37+
- type: checkboxes
38+
attributes:
39+
label: Will you help us by submitting a PR?
40+
options:
41+
- label: I will submit a PR about this issue.

‎.github/ISSUE_TEMPLATE/project-issue.yml‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
name: "\U0001F4AA Project issue (ticket)"
2+
description: Create a ticket to attain the goal in this project.
3+
title: "[Sprint] Please write your own title"
4+
labels: ["enhancement"]
5+
6+
body:
7+
- type: textarea
8+
id: description
9+
attributes:
10+
label: Is there any feature that you would like to add?
11+
description: Write a description for this ticket.
12+
validations:
13+
required: true
14+
15+
- type: checkboxes
16+
attributes:
17+
label: Checklits ✅
18+
options:
19+
- label: I would create a corresponding branch for this issue from the designated (mostly `develop`) branch.
20+
- label: This issue only contains a preceding agreement between project owners.

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
## Description
2+
3+
Please include a summary in English, of the changes in this pull request. If it closes an issue, please mention it here.
4+
5+
Closes: #(issue)
6+
7+
You should link at least one existing issue for PR. Before your create a PR, please check to see if there is an issue for this change.
8+
PRs from forked repository not accepted.
9+
10+
## Change(s)
11+
12+
- (Please write a description for this change.)

‎.github/release-drafter-config.yml‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
name-template: 'v$RESOLVED_VERSION'
2+
tag-template: 'v$RESOLVED_VERSION'
3+
categories:
4+
- title: '✨ Features'
5+
labels:
6+
- 'enhancement'
7+
- title: '🐛 Bug Fixes'
8+
labels:
9+
- 'bug'
10+
- title: '📘 Documents'
11+
labels:
12+
- 'documentation'
13+
- title: '🙈 Other changes'
14+
change-title-escapes: '\<*_&' # You can add # and @ to disable mentions, and add ` to disable code blocks.
15+
version-resolver:
16+
major:
17+
labels:
18+
- 'major'
19+
minor:
20+
labels:
21+
- 'minor'
22+
patch:
23+
labels:
24+
- 'patch'
25+
default: minor
26+
27+
exclude-labels:
28+
- 'skip-changelog'
29+
30+
template: |
31+
# What's Changed 🚀
32+
33+
$CHANGES
34+
35+
**Full Changelog**: https://github.com/$OWNER/$REPOSITORY/compare/$PREVIOUS_TAG...v$RESOLVED_VERSION

‎.github/workflows/check-code-format.yml‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
name: Code format check with Ruff
2+
3+
on:
4+
pull_request:
5+
branches:
6+
- develop
7+
types: [opened, synchronize, labeled, unlabeled]
8+
push:
9+
branches:
10+
- develop
11+
12+
jobs:
13+
ruff:
14+
runs-on: ubuntu-latest
15+
steps:
16+
- name: Checkout
17+
uses: actions/checkout@v3
18+
with:
19+
ref: ${{ github.event.pull_request.head.ref }}
20+
repository: ${{ github.event.pull_request.head.repo.full_name }}
21+
- uses: chartboost/ruff-action@v1
22+
with:
23+
src: "./netspresso"
24+
version: 0.0.259

‎.github/workflows/deployment.yml‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
name: Deploy to GitHub Pages
2+
3+
on:
4+
push:
5+
branches:
6+
- develop
7+
# Review gh actions docs if you want to further define triggers, paths, etc
8+
# https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on
9+
10+
permissions:
11+
contents: write
12+
13+
jobs:
14+
deploy:
15+
runs-on: ubuntu-latest
16+
steps:
17+
- uses: actions/checkout@v1
18+
# - uses: ammaraskar/sphinx-action@master
19+
# with:
20+
# docs-folder: "docs/"
21+
22+
# Docs: https://github.com/peaceiris/actions-gh-pages#%EF%B8%8F-docusaurus
23+
- name: Push to gh-pages
24+
uses: peaceiris/actions-gh-pages@v3
25+
with:
26+
personal_token: ${{ secrets.GITHUB_TOKEN }}
27+
# Build output to publish to the `gh-pages` branch:
28+
publish_dir: docs/_build/html
29+
# The following lines assign commit authorship to the official
30+
# GH-Actions bot for deploys to `gh-pages` branch:
31+
# https://github.com/actions/checkout/issues/13#issuecomment-724415212
32+
# The GH actions bot is used by default if you didn't specify the two fields.
33+
# You can swap them out with your own user credentials.
34+
user_name: github-actions[bot]
35+
user_email: github-actions[bot]@users.noreply.github.com

‎.github/workflows/docs-deploy.yml‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
name: Deploy documentation
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
8+
jobs:
9+
build-and-publish:
10+
runs-on: ubuntu-latest
11+
steps:
12+
- uses: actions/checkout@master
13+
- name: Set up Python 3.8
14+
uses: actions/setup-python@v3
15+
with:
16+
python-version: '3.8'
17+
- name: Install mkdocs
18+
run: |
19+
python -m pip install mkdocs
20+
- name: Install mkdocs-material
21+
run: |
22+
python -m pip install mkdocs-material
23+
- name: Publish docs
24+
run: |
25+
mkdocs gh-deploy --force

‎.github/workflows/pypi-package.yml‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
name: Publish Python distributions 📦 to PyPI
2+
3+
on:
4+
push:
5+
tags:
6+
- 'v*.*.*'
7+
8+
jobs:
9+
build-and-publish:
10+
runs-on: ubuntu-latest
11+
steps:
12+
- uses: actions/checkout@master
13+
14+
- name: Set up Python 3.8
15+
uses: actions/setup-python@v3
16+
with:
17+
python-version: '3.8'
18+
19+
- name: Install pypa/setuptools
20+
run: |
21+
python -m pip install wheel twine
22+
23+
- name: Extract tag name
24+
run: |
25+
VERSION_TAG=${GITHUB_REF_NAME#v}
26+
echo "VERSION_TAG=$VERSION_TAG" >> $GITHUB_ENV
27+
28+
- name: Extract version in package
29+
run: |
30+
VERSION_PKG=$(cat netspresso/VERSION)
31+
echo "VERSION_PKG=$VERSION_PKG" >> $GITHUB_ENV
32+
33+
- name: Build a binary wheel if tag is valid
34+
if: ${{ env.VERSION_TAG == env.VERSION_PKG }}
35+
run: |
36+
python setup.py sdist bdist_wheel
37+
38+
- name: Publish distribution 📦 to PyPI
39+
uses: pypa/gh-action-pypi-publish@release/v1
40+
with:
41+
password: ${{ secrets.PYPI_API_TOKEN }}

0 commit comments

Comments
 (0)