From 8583cc0618547ac0b8b9ace405ad26ff1365267f Mon Sep 17 00:00:00 2001 From: tinatn29 Date: Tue, 17 Jun 2025 16:24:42 -0400 Subject: [PATCH 1/4] skpkg: add config files for pre-commit --- .codespell/ignore_words.txt | 6 ------ 1 file changed, 6 deletions(-) diff --git a/.codespell/ignore_words.txt b/.codespell/ignore_words.txt index 9892d4d..04b4fcf 100644 --- a/.codespell/ignore_words.txt +++ b/.codespell/ignore_words.txt @@ -4,11 +4,5 @@ ;; abbreviation for "materials" often used in a journal title mater -;; alternative use of socioeconomic -socio-economic - ;; Frobenius norm used in np.linalg.norm fro - -;; cutted used as attribute in unit_test.py and fourigui.py -cutted From 0c1ceee6c77dcf4863ef68d05a4cdc59e23d7323 Mon Sep 17 00:00:00 2001 From: tinatn29 Date: Tue, 17 Jun 2025 16:24:55 -0400 Subject: [PATCH 2/4] skpkg: add config files readthedocs, codecov, GitHub --- .github/ISSUE_TEMPLATE/release_checklist.md | 14 ++++++------- .../pull_request_template.md | 15 +++++++++++++ .github/workflows/.yml | 0 .../workflows/build-wheel-release-upload.yml | 18 ---------------- .github/workflows/check-news-item.yml | 12 ----------- .../matrix-and-codecov-on-merge-to-main.yml | 21 ------------------- .github/workflows/publish-docs-on-release.yml | 12 ----------- .readthedocs.yaml | 13 ++++++++++++ 8 files changed, 35 insertions(+), 70 deletions(-) create mode 100644 .github/PULL_REQUEST_TEMPLATE/pull_request_template.md create mode 100644 .github/workflows/.yml delete mode 100644 .github/workflows/build-wheel-release-upload.yml delete mode 100644 .github/workflows/check-news-item.yml delete mode 100644 .github/workflows/matrix-and-codecov-on-merge-to-main.yml delete mode 100644 .github/workflows/publish-docs-on-release.yml create mode 100644 .readthedocs.yaml diff --git a/.github/ISSUE_TEMPLATE/release_checklist.md b/.github/ISSUE_TEMPLATE/release_checklist.md index fa94779..6107962 100644 --- a/.github/ISSUE_TEMPLATE/release_checklist.md +++ b/.github/ISSUE_TEMPLATE/release_checklist.md @@ -13,30 +13,30 @@ assignees: "" - [ ] License information is verified as correct. If you are unsure, please comment below. - [ ] Locally rendered documentation contains all appropriate pages, including API references (check no modules are missing), tutorials, and other human-written text is up-to-date with any changes in the code. -- [ ] Installation instructions in the README, documentation, and the website (e.g., diffpy.org) are updated. +- [ ] Installation instructions in the README, documentation, and the website are updated. - [ ] Successfully run any tutorial examples or do functional testing with the latest Python version. - [ ] Grammar and writing quality are checked (no typos). - [ ] 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. -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: +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: ### PyPI/GitHub full-release preparation checklist: - [ ] Create a new conda environment and install the rc from PyPI (`pip install ==??`) - [ ] License information on PyPI is correct. -- [ ] Docs are deployed successfully to `https://www.diffpy.org/`. +- [ ] Docs are deployed successfully to `https:///`. - [ ] Successfully run all tests, tutorial examples or do functional testing. -Please let @sbillinge know that all checks are done and the package is ready for full release. +Please let the maintainer know that all checks are done and the package is ready for full release. ### conda-forge release preparation checklist: - + - [ ] Ensure that the full release has appeared on PyPI successfully. - [ ] New package dependencies listed in `conda.txt` and `test.txt` are added to `meta.yaml` in the feedstock. -- [ ] Close any open issues on the feedstock. Reach out to @bobleesj if you have questions. -- [ ] Tag @sbillinge and @bobleesj for conda-forge release. +- [ ] Close any open issues on the feedstock. Reach out to the maintainer if you have questions. +- [ ] Tag the maintainer for conda-forge release. ### Post-release checklist diff --git a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md new file mode 100644 index 0000000..1099d86 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md @@ -0,0 +1,15 @@ +### What problem does this PR address? + + + +### What should the reviewer(s) do? + + + + diff --git a/.github/workflows/.yml b/.github/workflows/.yml new file mode 100644 index 0000000..e69de29 diff --git a/.github/workflows/build-wheel-release-upload.yml b/.github/workflows/build-wheel-release-upload.yml deleted file mode 100644 index a76326f..0000000 --- a/.github/workflows/build-wheel-release-upload.yml +++ /dev/null @@ -1,18 +0,0 @@ -name: Release (GitHub/PyPI) and Deploy Docs - -on: - workflow_dispatch: - push: - tags: - - "*" # Trigger on all tags initially, but tag and release privilege are verified in _build-wheel-release-upload.yml - -jobs: - release: - uses: Billingegroup/release-scripts/.github/workflows/_build-wheel-release-upload.yml@v0 - with: - project: diffpy.fourigui - c_extension: false - github_admin_username: sbillinge - secrets: - PYPI_TOKEN: ${{ secrets.PYPI_TOKEN }} - PAT_TOKEN: ${{ secrets.PAT_TOKEN }} diff --git a/.github/workflows/check-news-item.yml b/.github/workflows/check-news-item.yml deleted file mode 100644 index bffeec5..0000000 --- a/.github/workflows/check-news-item.yml +++ /dev/null @@ -1,12 +0,0 @@ -name: Check for News - -on: - pull_request_target: - branches: - - main - -jobs: - check-news-item: - uses: Billingegroup/release-scripts/.github/workflows/_check-news-item.yml@v0 - with: - project: diffpy.fourigui diff --git a/.github/workflows/matrix-and-codecov-on-merge-to-main.yml b/.github/workflows/matrix-and-codecov-on-merge-to-main.yml deleted file mode 100644 index 927a57a..0000000 --- a/.github/workflows/matrix-and-codecov-on-merge-to-main.yml +++ /dev/null @@ -1,21 +0,0 @@ -name: CI - -on: - push: - branches: - - main - release: - types: - - prereleased - - published - workflow_dispatch: - -jobs: - matrix-coverage: - uses: Billingegroup/release-scripts/.github/workflows/_matrix-and-codecov-on-merge-to-main.yml@v0 - with: - project: diffpy.fourigui - c_extension: false - headless: true - secrets: - CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }} diff --git a/.github/workflows/publish-docs-on-release.yml b/.github/workflows/publish-docs-on-release.yml deleted file mode 100644 index efd905b..0000000 --- a/.github/workflows/publish-docs-on-release.yml +++ /dev/null @@ -1,12 +0,0 @@ -name: Deploy Documentation on Release - -on: - workflow_dispatch: - -jobs: - docs: - uses: Billingegroup/release-scripts/.github/workflows/_publish-docs-on-release.yml@v0 - with: - project: diffpy.fourigui - c_extension: false - headless: true diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000..47f7a01 --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,13 @@ +version: 2 + +build: + os: "ubuntu-22.04" + tools: + python: "latest" + +python: + install: + - requirements: requirements/docs.txt + +sphinx: + configuration: doc/source/conf.py From 358a2ac5b1d1683025fe2b35147f6a4ed3451d83 Mon Sep 17 00:00:00 2001 From: tinatn29 Date: Tue, 17 Jun 2025 16:34:32 -0400 Subject: [PATCH 3/4] restore ignored words --- .codespell/ignore_words.txt | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.codespell/ignore_words.txt b/.codespell/ignore_words.txt index 04b4fcf..e1b7bd3 100644 --- a/.codespell/ignore_words.txt +++ b/.codespell/ignore_words.txt @@ -6,3 +6,6 @@ mater ;; Frobenius norm used in np.linalg.norm fro + +;; cutted used as attribute in unit_test.py and fourigui.py +cutted From 9a64023a64171357fa71a4b542b073fce358b200 Mon Sep 17 00:00:00 2001 From: tinatn29 Date: Tue, 17 Jun 2025 16:36:51 -0400 Subject: [PATCH 4/4] restore ignored words socio-economic --- .codespell/ignore_words.txt | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.codespell/ignore_words.txt b/.codespell/ignore_words.txt index e1b7bd3..9892d4d 100644 --- a/.codespell/ignore_words.txt +++ b/.codespell/ignore_words.txt @@ -4,6 +4,9 @@ ;; abbreviation for "materials" often used in a journal title mater +;; alternative use of socioeconomic +socio-economic + ;; Frobenius norm used in np.linalg.norm fro