Skip to content

Commit 99b28f0

Browse files
committed
add untrack files in cookiecutter
1 parent f330de1 commit 99b28f0

File tree

6 files changed

+104
-0
lines changed

6 files changed

+104
-0
lines changed

.github/workflows/check-news-item.yml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
name: Check for News
2+
3+
on:
4+
pull_request_target:
5+
branches:
6+
- main
7+
8+
jobs:
9+
build:
10+
uses: Billingegroup/release-scripts/.github/workflows/_check-news-item.yml@v0
11+
with:
12+
project: diffpy.srmise
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
name: CI
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
release:
8+
types:
9+
- prereleased
10+
- published
11+
workflow_dispatch:
12+
13+
jobs:
14+
coverage:
15+
uses: Billingegroup/release-scripts/.github/workflows/_matrix-and-codecov-on-merge-to-main.yml@v0
16+
with:
17+
project: diffpy.srmise
18+
c_extension: false
19+
headless: false
20+
secrets:
21+
CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
name: Build and Deploy Docs
2+
3+
on:
4+
release:
5+
types:
6+
- published
7+
workflow_dispatch:
8+
9+
jobs:
10+
docs:
11+
uses: Billingegroup/release-scripts/.github/workflows/_publish-docs-on-release.yml@v0
12+
with:
13+
project: diffpy.srmise
14+
c_extension: false

.github/workflows/tests-on-pr.yml

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
name: Tests on PR
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
pull_request:
8+
workflow_dispatch:
9+
10+
jobs:
11+
validate:
12+
uses: Billingegroup/release-scripts/.github/workflows/_tests-on-pr.yml@v0
13+
with:
14+
project: diffpy.srmise
15+
c_extension: false
16+
headless: false
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
.. _example_package documentation:
2+
3+
|title|
4+
=======
5+
6+
.. |title| replace:: diffpy.srmise.example_package package
7+
8+
.. automodule:: diffpy.srmise.example_package
9+
:members:
10+
:undoc-members:
11+
:show-inheritance:
12+
13+
|foo|
14+
-----
15+
16+
.. |foo| replace:: diffpy.srmise.example_package.foo module
17+
18+
.. automodule:: diffpy.srmise.example_package.foo
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:
22+
23+
|bar|
24+
-----
25+
26+
.. |bar| replace:: diffpy.srmise.example_package.bar module
27+
28+
.. automodule:: diffpy.srmise.example_package.foo
29+
:members:
30+
:undoc-members:
31+
:show-inheritance:

tests/test_version.py

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
"""Unit tests for __version__.py
2+
"""
3+
4+
import diffpy.srmise
5+
6+
7+
def test_package_version():
8+
"""Ensure the package version is defined and not set to the initial placeholder."""
9+
assert hasattr(diffpy.srmise, "__version__")
10+
assert diffpy.srmise.__version__ != "0.0.0"

0 commit comments

Comments
 (0)