Skip to content
This repository was archived by the owner on Jun 27, 2025. It is now read-only.

Commit d94a96c

Browse files
arthansonarthanson
authored
Updates to github actions, precommit - add pyproject.toml (#16)
1 parent c1e4a63 commit d94a96c

25 files changed

+845
-590
lines changed

‎.github/ISSUE_TEMPLATE/01_BUG_REPORT.md‎

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

‎.github/ISSUE_TEMPLATE/02_FEATURE_REQUEST.md‎

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

‎.github/ISSUE_TEMPLATE/03_CODEBASE_IMPROVEMENT.md‎

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

‎.github/ISSUE_TEMPLATE/bug_report.yaml‎

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
---
2+
name: 🐛 Bug Report
3+
description: Report a reproducible bug in the current release of NetBox Python
4+
labels: ["type: bug"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: >
9+
**NOTE:** This form is only for reporting _reproducible bugs_ in a current NetBox Python release.
10+
- type: input
11+
attributes:
12+
label: NetBox Python version
13+
description: What version of NetBox Python are you currently running?
14+
placeholder: v0.1.0
15+
validations:
16+
required: true
17+
- type: input
18+
attributes:
19+
label: NetBox version
20+
description: What version of NetBox are you currently running?
21+
placeholder: v3.6.0
22+
validations:
23+
required: true
24+
- type: dropdown
25+
attributes:
26+
label: Python version
27+
description: What version of Python are you currently running?
28+
options:
29+
- "3.8"
30+
- "3.9"
31+
- "3.10"
32+
- "3.11"
33+
validations:
34+
required: true
35+
- type: textarea
36+
attributes:
37+
label: Steps to Reproduce
38+
description: >
39+
Please provide a minimal working example to demonstrate the bug. Begin with the
40+
initialization of any necessary database objects and clearly enumerate each
41+
operation carried out. Ensure that your example is as concise as possible
42+
while adequately illustrating the issue.
43+
44+
_Please refrain from including any confidential or sensitive
45+
information in your example._
46+
validations:
47+
required: true
48+
- type: textarea
49+
attributes:
50+
label: Expected Behavior
51+
description: What did you expect to happen?
52+
placeholder: The script should execute without raising any errors or exceptions
53+
validations:
54+
required: true
55+
- type: textarea
56+
attributes:
57+
label: Observed Behavior
58+
description: What happened instead?
59+
placeholder: A TypeError exception was raised
60+
validations:
61+
required: true

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,12 @@
1-
---
1+
# Reference: https://help.github.com/en/github/building-a-strong-community/configuring-issue-templates-for-your-repository#configuring-the-template-chooser
22
blank_issues_enabled: false
33
contact_links:
4-
- name: NetBox Python Community Support
5-
url: https://github.com/netbox-community/netbox-python/discussions
6-
about: Please ask and answer questions here.
4+
- name: 📖 Contributing Policy
5+
url: https://github.com/netbox-community/netbox_python/blob/main/CONTRIBUTING.md
6+
about: "Please read through our contributing policy before opening an issue or pull request."
7+
- name: ❓ Discussion
8+
url: https://github.com/netbox-community/netbox_python/discussions
9+
about: "If you're just looking for help, try starting a discussion instead."
10+
- name: 💬 Community Slack
11+
url: https://netdev.chat
12+
about: "Join #netbox on the NetDev Community Slack for assistance with installation issues and other problems."

‎.github/ISSUE_TEMPLATE/feature_request.yaml‎

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
---
2+
name: ✨ Feature Request
3+
description: Propose a new NetBox Python feature or enhancement
4+
labels: ["type: feature"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: >
9+
**NOTE:** This form is only for submitting well-formed proposals to extend or modify
10+
NetBox Python in some way. If you're trying to solve a problem but can't figure out how, or if
11+
you still need time to work on the details of a proposed new feature, please start a
12+
[discussion](https://github.com/netbox-community/pynetbox/discussions) instead.
13+
- type: input
14+
attributes:
15+
label: NetBox Python version
16+
description: What version of NetBox Python are you currently running?
17+
placeholder: v0.1.0
18+
validations:
19+
required: true
20+
- type: input
21+
attributes:
22+
label: NetBox version
23+
description: What version of NetBox are you currently running?
24+
placeholder: v3.6.0
25+
validations:
26+
required: true
27+
- type: dropdown
28+
attributes:
29+
label: Feature type
30+
options:
31+
- Data model extension
32+
- New functionality
33+
- Change to existing functionality
34+
validations:
35+
required: true
36+
- type: textarea
37+
attributes:
38+
label: Proposed functionality
39+
description: >
40+
Describe in detail the new feature or behavior you are proposing. Include any specific changes
41+
to work flows, data models, and/or the user interface. The more detail you provide here, the
42+
greater chance your proposal has of being discussed. Feature requests which don't include an
43+
actionable implementation plan will be rejected.
44+
validations:
45+
required: true
46+
- type: textarea
47+
attributes:
48+
label: Use case
49+
description: >
50+
Explain how adding this functionality would benefit NetBox Python users. What need does it address?
51+
validations:
52+
required: true
53+
- type: textarea
54+
attributes:
55+
label: External dependencies
56+
description: >
57+
List any new dependencies on external libraries or services that this new feature would
58+
introduce. For example, does the proposal require the installation of a new Python package?
59+
(Not all new features introduce new dependencies.)

‎.github/ISSUE_TEMPLATE/housekeeping.yaml‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
name: 🏡 Housekeeping
3+
description: A change pertaining to the codebase itself (developers only)
4+
labels: ["type: housekeeping"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: >
9+
**NOTE:** This template is for use by maintainers only. Please do not submit
10+
an issue using this template unless you have been specifically asked to do so.
11+
- type: textarea
12+
attributes:
13+
label: Proposed Changes
14+
description: >
15+
Describe in detail the new feature or behavior you'd like to propose.
16+
Include any specific changes to work flows, data models, or the user interface.
17+
validations:
18+
required: true
19+
- type: textarea
20+
attributes:
21+
label: Justification
22+
description: Please provide justification for the proposed change(s).
23+
validations:
24+
required: true

‎.github/PULL_REQUEST_TEMPLATE.md‎

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

‎.github/labels.yml‎

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

‎.github/workflows/mkdocs.yml‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
name: ci
2+
on:
3+
push:
4+
branches:
5+
- master
6+
- main
7+
permissions:
8+
contents: write
9+
jobs:
10+
deploy:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- uses: actions/checkout@v3
14+
- uses: actions/setup-python@v4
15+
with:
16+
python-version: 3.x
17+
- run: pip install mkdocs-material mkdocs-autorefs mkdocs-material-extensions mkdocstrings mkdocstrings-python-legacy mkdocs-include-markdown-plugin
18+
- run: mkdocs gh-deploy --force

0 commit comments

Comments
 (0)