Skip to content

Commit 13f8cdc

Browse files
rknoprknop
committed
testing
0 parents  commit 13f8cdc

38 files changed

+1440
-0
lines changed

‎.cruft.json‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
{
2+
"template": "/home/raknop/roman/package-template",
3+
"commit": "1daf5045485044ce2db16a092cd1c5e235995965",
4+
"checkout": "u/rknop/patch2",
5+
"context": {
6+
"cookiecutter": {
7+
"package_name": "pkg_deleteme",
8+
"module_name": "deleteme",
9+
"github_snpit_repo_name": "rknop_test_deleteme",
10+
"short_description": "Developed by the Roman Supernova PIT",
11+
"author_name": "",
12+
"author_email": "",
13+
"github_username": "",
14+
"minimum_python_version": "3.11",
15+
"use_compiled_extensions": "n",
16+
"include_example_code": "n",
17+
"include_github_workflows": "y",
18+
"_project_url": "https://github.com/Roman-Supernova-PIT",
19+
"_pit_github_org": "Roman-Supernova-PIT",
20+
"_pit_name": "Roman Supernove Project Infrastructure Team",
21+
"_sphinx_theme": "alabaster",
22+
"_parent_project": "",
23+
"install_requires": "",
24+
"_copy_without_render": [
25+
"docs/_templates",
26+
"docs/_static",
27+
".github/workflows",
28+
".github/"
29+
],
30+
"_template": "/home/raknop/roman/package-template",
31+
"_commit": "1daf5045485044ce2db16a092cd1c5e235995965"
32+
}
33+
},
34+
"directory": null
35+
}

‎.github/CODEOWNERS‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# automatically requests pull request reviews for files matching the given pattern; the last match takes precendence. Make sure the software-admin team has write on your repo
2+
3+
* @ @Roman-Supernova-Pit/software-admins
4+
5+
# maintainers, add specifics of what you want to maintain for your package
6+
# the software-admins should remain owners of everything as above

‎.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
name: "Feature request"
3+
about: Suggest an idea for this project
4+
title: "[New Feature]: "
5+
labels: enhancement, needs triage
6+
assignees: ''
7+
---
8+
9+
## Is your feature request related to a problem? Please describe.
10+
<!--A clear and concise description of what the problem is.
11+
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.-->
21+

‎.github/ISSUE_TEMPLATE/ISSUE_TEMPLATE.md‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
---
2+
name: "🐞 Issue report for pkg_deleteme"
3+
about: Create a report describing unexpected or incorrect behavior.
4+
title: "[Issue]: <title>"
5+
labels: bug
6+
assignees: ''
7+
---
8+
9+
<!--
10+
Thanks for taking the time to fill out this report!
11+
Please have a search on our repository to see if a similar
12+
issue has already been posted. If a similar issue is closed, have a
13+
quick look to see if you are satisfied by the resolution.
14+
15+
If not please go ahead and open an issue!
16+
-->
17+
18+
### Current Behavior:
19+
<!-- A concise description of what you're experiencing. -->
20+
21+
### Expected Behavior:
22+
<!-- A concise description of what you expected to happen. -->
23+
24+
### Steps To Reproduce:
25+
<!--
26+
Example: steps to reproduce the behavior:
27+
1. In this environment...
28+
1. With this config...
29+
1. Run '...'
30+
1. See error...
31+
-->
32+
33+
### Environment:
34+
<!--
35+
Example:
36+
- OS: Ubuntu 20.04
37+
- Node: 13.14.0
38+
- npm: 7.6.3
39+
- python: 3.13
40+
- numpy: 2.0
41+
-->
42+
43+
### Anything else:
44+
<!--
45+
Links? References? Anything that will give us more context about the issue that you are encountering!
46+
-->
47+

‎.github/ISSUE_TEMPLATE/PR_TEMPLATE.md‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
---
2+
name: "Pull Request for pkg_deleteme"
3+
about: Create a pull request to submit new or updated code to the repository
4+
title: "[PR]: "
5+
labels: possible solution
6+
assignees: ''
7+
---
8+
## What type of PR is this? (check all applicable)
9+
10+
- [ ] Refactor
11+
- [ ] Feature
12+
- [ ] Bug Fix
13+
- [ ] Optimization
14+
- [ ] Documentation Update
15+
- [ ] Have you followed the guidelines in our Contributing document?
16+
- [ ] Have you checked to ensure there aren't other open [Pull Requests](../../../pulls) for the same update/change?
17+
18+
<!-- describe the changes included with this PR here -->
19+
This PR addresses ...
20+
21+
<!-- If this PR closes a GitHub issue, reference it here by its number -->
22+
Closes #
23+
24+
25+
<!-- if you can't perform these tasks due to permissions, please ask a maintainer to do them -->
26+
## Tasks
27+
- [ ] **request a review from someone specific**, to avoid making the maintainers review every PR
28+
- [ ] Does this PR change user-facing code / API? (if not, label with `no-changelog-entry-needed`)
29+
- [ ] write news fragment(s) in `changes/`: `echo "changed something" > changes/<PR#>.<changetype>.rst` (see expansion below for change types)
30+
- [ ] update or add relevant tests
31+
- [ ] update relevant docstrings and / or `docs/` page
32+
- [ ] Do truth files need to be updated?
33+
34+
35+
<details><summary>news fragment change types...</summary>
36+
37+
- ``changes/<PR#>.general.rst``: infrastructure or miscellaneous change
38+
- ``changes/<PR#>.docs.rst``: updates for documentation
39+
</details>

‎.github/dependabot.yml‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
name: "Dependabot Checks"
2+
version: 2
3+
updates:
4+
5+
# maintain dependencies for pip
6+
# this should help with pyproject.toml
7+
- package-ecosystem: pip
8+
directory: "/"
9+
target-branch: "main"
10+
schedule:
11+
interval: weekly
12+
open-pull-requests-limit: 10
13+
reviewers:
14+
- ""
15+
allow:
16+
- dependency-type: direct
17+
- dependency-type: indirect
18+
commit-message:
19+
prefix: "fix: "
20+
labels:
21+
- "CI/CD"
22+
23+
# maintain dependencies for github-actions
24+
- package-ecosystem: "github-actions"
25+
directory: ".github/workflows"
26+
target-branch: "main"
27+
reviewers:
28+
- ""
29+
schedule:
30+
interval: monthly
31+
commit-message:
32+
prefix: "fix: "
33+
labels:
34+
- "CI/CD"
35+
groups:
36+
actions:
37+
patterns:
38+
- "*"

‎.github/labeler.yml‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# needs pull_request_target to label forks
2+
documentation:
3+
- changed-files:
4+
- all-globs-to-any-file: ['*.rst', '!CHANGES.rst', '!licenses/LICENSE']
5+
- any-glob-to-any-file:
6+
- 'docs/**/*'
7+
- '*.md'
8+
- '.readthedocs.yaml'
9+
- 'CITATION.cff'
10+
11+
installation:
12+
- changed-files:
13+
- any-glob-to-any-file:
14+
- 'pyproject.toml'
15+
- 'setup.*'
16+
- 'requirements*.txt'
17+
- 'MANIFEST.in'
18+
19+
# --------------------------------------- testing ---------------------------------------
20+
21+
automation:
22+
- changed-files:
23+
- any-glob-to-any-file:
24+
- '.github/**'
25+
- '.bandit.yaml'
26+
- '.codecov.yml'
27+
28+
testing:
29+
- changed-files:
30+
- any-glob-to-any-file:
31+
- '**/tests/**'
32+
- '.github/workflows/*ci*.yml'
33+
- 'conftest.py'
34+
- 'tox.ini'

‎.github/workflows/changelog.yml‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
name: changelog
2+
3+
on:
4+
pull_request:
5+
types:
6+
- labeled
7+
- unlabeled
8+
- opened
9+
- synchronize
10+
- reopened
11+
12+
concurrency:
13+
group: ${{ github.workflow }}-${{ github.ref }}
14+
cancel-in-progress: true
15+
16+
jobs:
17+
check:
18+
runs-on: ubuntu-latest
19+
steps:
20+
- uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b # v5.3.0
21+
with:
22+
python-version: 3
23+
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
24+
with:
25+
fetch-depth: 0
26+
- run: pip install .
27+
- run: pip install towncrier
28+
- run: towncrier check
29+
- run: towncrier build --draft | grep -P '#${{ github.event.number }}'
30+
prevent_manually_editing_changlog:
31+
runs-on: ubuntu-latest
32+
steps:
33+
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
34+
with:
35+
fetch-depth: 0
36+
- name: prevent direct changes to `CHANGES.rst`
37+
run: git diff HEAD ${{ github.event.pull_request.base.sha }} --no-patch --exit-code CHANGES.rst

‎.github/workflows/run_labeler.yml‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
name: Label pull request
2+
3+
on:
4+
pull_request_target:
5+
types:
6+
- opened
7+
- synchronized
8+
- reopened
9+
10+
jobs:
11+
labeler:
12+
permissions:
13+
contents: read
14+
pull-requests: write
15+
runs-on: ubuntu-latest
16+
steps:
17+
- uses: actions/labeler@8558fd74291d67161a8a78ce36a881fa63b766a9 # v5.0.0
18+
with:
19+
repo-token: "${{ secrets.GITHUB_TOKEN }}"
20+
sync-labels: true # removes labels when files reverted
21+
configuration-path: .github/labeler.yml
22+

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

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
name: "Deploy Package Documentation to Pages"
2+
3+
on:
4+
push:
5+
branches: [main] # branch to trigger deployment
6+
7+
workflow_dispatch:
8+
9+
jobs:
10+
pages:
11+
runs-on: ubuntu-latest
12+
permissions:
13+
contents: write
14+
steps:
15+
- id: deployment
16+
uses: sphinx-notes/pages@3a7b173ecba074b270b37c64007c1edfd8465892 # v3.1
17+
with:
18+
publish: false
19+
documentation_path: ./docs
20+
pyproject_extras: docs
21+
- uses: peaceiris/actions-gh-pages@4f9cc6602d3f66b9c108549d475ec49e8ef4d45e # v4.0.0
22+
with:
23+
github_token: ${{ secrets.GITHUB_TOKEN }}
24+
publish_dir: ${{ steps.deployment.outputs.artifact }}
25+
publish_branch: gh-pages # default: gh-pages
26+
commit_message: ${{ github.event.head_commit.message }}
27+

0 commit comments

Comments
 (0)