Skip to content

Commit 9f52ef5

Browse files
committed
Add codespell
1 parent 2dc1893 commit 9f52ef5

9 files changed

Lines changed: 71 additions & 23 deletions

.codespell/ignore_lines.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
;; Please include filenames and explanations for each ignored line.
2+
;; See https://docs.openverse.org/meta/codespell.html for docs.

.codespell/ignore_words.txt

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
;; Please include explanations for each ignored word (lowercase).
2+
;; See https://docs.openverse.org/meta/codespell.html for docs.
3+
4+
;; abbreviation for "materials" often used in a journal title
5+
mater
6+
7+
;; alternative use of socioeconomic
8+
socio-economic
9+
10+
;; Frobenius norm used in np.linalg.norm
11+
fro
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
name: Bug Report or Feature Request
3+
about: Report a bug or suggest a new feature!
4+
title: ""
5+
labels: ""
6+
assignees: ""
7+
---
8+
9+
### Problem
10+
11+
<!--
12+
For a bug report, please copy and paste any error messages from the application or command-line here.
13+
For a feature request, please state how the new functionality could benefit the community.
14+
-->
15+
16+
### Proposed solution
Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
name: Release
3+
about: Checklist and communication channel for PyPI and GitHub release
4+
title: "Ready for <version-number> PyPI/GitHub release"
5+
labels: "release"
6+
assignees: ""
7+
---
8+
9+
### PyPI/GitHub release checklist:
10+
11+
- [ ] All PRs/issues attached to the release are merged.
12+
- [ ] All the badges on the README are passing.
13+
- [ ] License information is verified as correct. If you are unsure, please comment below.
14+
- [ ] 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.
16+
- [ ] Installation instructions in the README, documentation and on the website (e.g., diffpy.org) are updated.
17+
- [ ] Successfully run any tutorial examples or do functional testing with the latest Python version.
18+
- [ ] Grammar and writing quality are checked (no typos).
19+
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:
22+
23+
### conda-forge release checklist:
24+
25+
<!-- After @sbillinge releases the PyPI package, please check the following when creating a PR for conda-forge release.-->
26+
27+
- [ ] 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.
29+
30+
### Post-release checklist
31+
32+
<!-- Before closing this issue, please complete the following: -->
33+
34+
- [ ] Run tutorial examples and conduct functional testing using the installation guide in the README. Attach screenshots/results as comments.
35+
- [ ] Documentation (README, tutorials, API references, and websites) is deployed without broken links or missing figures.
Lines changed: 2 additions & 6 deletions
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:
@@ -8,13 +8,9 @@ on:
88

99
jobs:
1010
release:
11-
permissions:
12-
contents: write
13-
uses: bobleesj/release-scripts/.github/workflows/_build-wheel-release-upload.yml@v0
11+
uses: Billingegroup/release-scripts/.github/workflows/_build-wheel-release-upload.yml@v0
1412
with:
1513
project: diffpy.pdffit2
16-
c_extension: true
17-
1814
secrets:
1915
PYPI_TOKEN: ${{ secrets.PYPI_TOKEN }}
2016
PAT_TOKEN: ${{ secrets.PAT_TOKEN }}

.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-
build:
9+
check-news-item:
1010
uses: Billingegroup/release-scripts/.github/workflows/_check-news-item.yml@v0
1111
with:
1212
project: diffpy.pdffit2

.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-
coverage:
14+
matrix-coverage:
1515
uses: Billingegroup/release-scripts/.github/workflows/_matrix-and-codecov-on-merge-to-main.yml@v0
1616
with:
1717
project: diffpy.pdffit2

.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: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,11 @@ on:
88
workflow_dispatch:
99

1010
jobs:
11-
validate:
11+
tests-on-pr:
1212
uses: Billingegroup/release-scripts/.github/workflows/_tests-on-pr.yml@v0
1313
with:
1414
project: diffpy.pdffit2
1515
c_extension: true
1616
headless: false
17+
secrets:
18+
CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}

0 commit comments

Comments
 (0)