Skip to content

Commit d017240

Browse files
committed
skpkg: add config files readthedocs, codecov, GitHub
1 parent d7e68c2 commit d017240

File tree

3 files changed

+50
-7
lines changed

3 files changed

+50
-7
lines changed

.github/ISSUE_TEMPLATE/release_checklist.md

Lines changed: 22 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,26 +6,41 @@ labels: "release"
66
assignees: ""
77
---
88

9-
### PyPI/GitHub release checklist:
9+
### PyPI/GitHub rc-release preparation checklist:
1010

1111
- [ ] All PRs/issues attached to the release are merged.
1212
- [ ] All the badges on the README are passing.
1313
- [ ] License information is verified as correct. If you are unsure, please comment below.
1414
- [ ] Locally rendered documentation contains all appropriate pages, including API references (check no modules are
15+
<<<<<<< Updated upstream
1516
missing), tutorials, and other human written text is up-to-date with any changes in the code.
16-
- [ ] Installation instructions in the README, documentation and on the website (e.g., diffpy.org) are updated.
17+
- [ ] # Installation instructions in the README, documentation and on the website (e.g., diffpy.org) are updated.
18+
missing), tutorials, and other human-written text is up-to-date with any changes in the code.
19+
- [ ] Installation instructions in the README, documentation, and the website are updated.
20+
> > > > > > > Stashed changes
1721
- [ ] Successfully run any tutorial examples or do functional testing with the latest Python version.
1822
- [ ] Grammar and writing quality are checked (no typos).
23+
- [ ] Install `pip install build twine`, run `python -m build` and `twine check dist/*` to ensure that the package can be built and is correctly formatted for PyPI release.
1924

20-
Please mention @sbillinge here when you are ready for PyPI/GitHub release. Include any additional comments necessary, such as
21-
version information and details about the pre-release here:
25+
Please tag the maintainer (e.g., @username) in the comment here when you are ready for the PyPI/GitHub release. Include any additional comments necessary, such as version information and details about the pre-release here:
2226

23-
### conda-forge release checklist:
27+
### PyPI/GitHub full-release preparation checklist:
2428

25-
<!-- After @sbillinge releases the PyPI package, please check the following when creating a PR for conda-forge release.-->
29+
- [ ] Create a new conda environment and install the rc from PyPI (`pip install <package-name>==??`)
30+
- [ ] License information on PyPI is correct.
31+
- [ ] Docs are deployed successfully to `https://<github-username-or-orgname>/<package-name>`.
32+
- [ ] Successfully run all tests, tutorial examples or do functional testing.
2633

34+
Please let the maintainer know that all checks are done and the package is ready for full release.
35+
36+
### conda-forge release preparation checklist:
37+
38+
<!-- After the maintainer releases the PyPI package, please check the following when creating a PR for conda-forge release.-->
39+
40+
- [ ] Ensure that the full release has appeared on PyPI successfully.
2741
- [ ] New package dependencies listed in `conda.txt` and `test.txt` are added to `meta.yaml` in the feedstock.
28-
- [ ] All relevant issues in the feedstock are addressed in the release PR.
42+
- [ ] Close any open issues on the feedstock. Reach out to the maintainer if you have questions.
43+
- [ ] Tag the maintainer for conda-forge release.
2944

3045
### Post-release checklist
3146

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
### What problem does this PR address?
2+
3+
<!-- Provide a brief overview and link to the issue. Attach outputs, including screenshots (before/after), if helpful for the reviewer. -->
4+
5+
### What should the reviewer(s) do?
6+
7+
<!-- Merge the code, provide feedback, initiate a discussion, etc. -->
8+
9+
<!--
10+
Use the following checklist items when applicable (select only what applies):
11+
- [ ] This PR introduces a public-facing change (e.g., figures, CLI input/output, API).
12+
- [ ] Documentation (e.g., tutorials, examples, README) has been updated.
13+
- [ ] A tracking issue or plan to update documentation exists.
14+
- [ ] This PR affects internal functionality only (no user-facing change).
15+
-->

.readthedocs.yaml

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
version: 2
2+
3+
build:
4+
os: "ubuntu-22.04"
5+
tools:
6+
python: "latest"
7+
8+
python:
9+
install:
10+
- requirements: requirements/docs.txt
11+
12+
sphinx:
13+
configuration: doc/source/conf.py

0 commit comments

Comments
 (0)