Skip to content

Commit 0542b86

Browse files
authored
ci: update workflows align with scikit-package (#245)
* ci: update workflows align with scikit-package * add news
1 parent 8f71834 commit 0542b86

File tree

5 files changed

+31
-7
lines changed

5 files changed

+31
-7
lines changed

Diff for: .github/ISSUE_TEMPLATE/release_checklist.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,11 @@ assignees: ""
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-
missing), tutorials, and other human-written text is up-to-date with any changes in the code.
15+
missing), tutorials, and other human-written text is up-to-date with any changes in the code.
1616
- [ ] Installation instructions in the README, documentation, and the website (e.g., diffpy.org) are updated.
1717
- [ ] Successfully run any tutorial examples or do functional testing with the latest Python version.
1818
- [ ] Grammar and writing quality are checked (no typos).
19-
- [ ] 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.
19+
- [ ] 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.
2020

2121
Please mention @sbillinge here when you are ready for PyPI/GitHub release. Include any additional comments necessary, such as version information and details about the pre-release here:
2222

@@ -42,5 +42,5 @@ Please let @sbillinge know that all checks are done and the package is ready for
4242

4343
<!-- Before closing this issue, please complete the following: -->
4444

45-
- [ ] Run tutorial examples and conduct functional testing using the installation guide in the README. Attach screenshots/results as comments.
46-
- [ ] Documentation (README, tutorials, API references, and websites) is deployed without broken links or missing figures.
45+
- [ ] Run tutorial examples and conduct functional testing using the installation guide in the README. Attach screenshots/results as comments.
46+
- [ ] Documentation (README, tutorials, API references, and websites) is deployed without broken links or missing figures.

Diff for: .github/workflows/build-wheel-release-upload.yml

+3-1
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,15 @@ on:
44
workflow_dispatch:
55
push:
66
tags:
7-
- '*' # Trigger on all tags initially, but tag and release privilege are verified in _build-wheel-release-upload.yml
7+
- "*" # Trigger on all tags initially, but tag and release privilege are verified in _build-wheel-release-upload.yml
88

99
jobs:
1010
release:
1111
uses: Billingegroup/release-scripts/.github/workflows/_build-wheel-release-upload.yml@v0
1212
with:
1313
project: diffpy.pdfgui
14+
c_extension: false
15+
github_admin_username: sbillinge
1416
secrets:
1517
PYPI_TOKEN: ${{ secrets.PYPI_TOKEN }}
1618
PAT_TOKEN: ${{ secrets.PAT_TOKEN }}

Diff for: .github/workflows/check-news-item.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ name: Check for News
33
on:
44
pull_request_target:
55
branches:
6-
- main
6+
- main
77

88
jobs:
99
check-news-item:

Diff for: .github/workflows/publish-docs-on-release.yml

-1
Original file line numberDiff line numberDiff line change
@@ -12,4 +12,3 @@ jobs:
1212
project: diffpy.pdfgui
1313
c_extension: false
1414
headless: true
15-
python_version: 3.12

Diff for: news/updatewf.rst

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
**Added:**
2+
3+
* no news: modification on CI workflow
4+
5+
**Changed:**
6+
7+
* <news item>
8+
9+
**Deprecated:**
10+
11+
* <news item>
12+
13+
**Removed:**
14+
15+
* <news item>
16+
17+
**Fixed:**
18+
19+
* <news item>
20+
21+
**Security:**
22+
23+
* <news item>

0 commit comments

Comments
 (0)