Skip to content

Commit c79ebb4

Browse files
committed
modify issue checklist
1 parent 0b90f3e commit c79ebb4

File tree

7 files changed

+17
-25
lines changed

7 files changed

+17
-25
lines changed

.github/ISSUE_TEMPLATE/release_checklist.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,16 @@ assignees: ""
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
1515
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 and
17-
tested
18-
- [ ] Successfully run any tutorial examples or do functional testing in some other way.
16+
- [ ] Installation instructions in the README, documentation and on the website (e.g., diffpy.org) updated.
17+
- [ ] Successfully run any tutorial examples or do functional testing with the latest Python version
1918
- [ ] Grammar and writing quality have been checked (no typos).
2019

2120
Please mention @sbillinge when you are ready for release. Include any additional comments necessary, such as
22-
version information and details about the pre-release.
21+
version information and details about the pre-release here:
22+
23+
### Post-release checklist
24+
25+
Before closing this issue, please complete the following:
26+
27+
- [ ] Run tutorial examples and conduct functional testing using the installation guide in the README.
28+
- [ ] Documentation (README, tutorials, API references, and websites) is deployed without broken links or missing figures.

.github/workflows/build-wheel-release-upload.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: Release (GitHub/PyPI)
1+
name: Release (GitHub/PyPI) and Deploy Docs
22

33
on:
44
workflow_dispatch:

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ on:
66
- main
77

88
jobs:
9-
check-news-item:
9+
build:
1010
uses: Billingegroup/release-scripts/.github/workflows/_check-news-item.yml@v0
1111
with:
1212
project: diffpy.utils

.github/workflows/matrix-and-codecov-on-merge-to-main.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ on:
1111
workflow_dispatch:
1212

1313
jobs:
14-
CI:
14+
coverage:
1515
uses: Billingegroup/release-scripts/.github/workflows/_matrix-and-codecov-on-merge-to-main.yml@v0
1616
with:
1717
project: diffpy.utils

.github/workflows/publish-docs-on-release.yml

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

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ on:
88
workflow_dispatch:
99

1010
jobs:
11-
tests-on-pr:
11+
validate:
1212
uses: Billingegroup/release-scripts/.github/workflows/_tests-on-pr.yml@v0
1313
with:
1414
project: diffpy.utils

.pre-commit-config.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,6 @@ repos:
4747
- repo: https://github.com/codespell-project/codespell
4848
rev: v2.3.0
4949
hooks:
50-
- id: codespell
51-
additional_dependencies:
52-
- tomli
50+
- id: codespell
51+
additional_dependencies:
52+
- tomli

0 commit comments

Comments
 (0)