From e4a965b98bd7128b8922cf39fb2a683d6f5342e3 Mon Sep 17 00:00:00 2001 From: Caden Myers Date: Wed, 23 Oct 2024 10:57:46 -0400 Subject: [PATCH 1/5] workflows --- .github/ISSUE_TEMPLATE/bug_feature.md | 16 ++++++++++++++ .github/ISSUE_TEMPLATE/release_checklist.md | 22 +++++++++++++++++++ .../workflows/build-wheel-release-upload.yml | 16 ++++++++++++++ 3 files changed, 54 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_feature.md create mode 100644 .github/ISSUE_TEMPLATE/release_checklist.md create mode 100644 .github/workflows/build-wheel-release-upload.yml diff --git a/.github/ISSUE_TEMPLATE/bug_feature.md b/.github/ISSUE_TEMPLATE/bug_feature.md new file mode 100644 index 0000000..b3454de --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_feature.md @@ -0,0 +1,16 @@ +--- +name: Bug Report or Feature Request +about: Report a bug or suggest a new feature! +title: "" +labels: "" +assignees: "" +--- + +### Problem + + + +### Proposed solution diff --git a/.github/ISSUE_TEMPLATE/release_checklist.md b/.github/ISSUE_TEMPLATE/release_checklist.md new file mode 100644 index 0000000..a87a44a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/release_checklist.md @@ -0,0 +1,22 @@ +--- +name: Release +about: Checklist and communication channel for PyPI and GitHub release +title: "Ready for PyPI/GitHub release" +labels: "release" +assignees: "" +--- + +### Release checklist for GitHub contributors + +- [ ] All PRs/issues attached to the release are merged. +- [ ] All the badges on the README are passing. +- [ ] 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 on the website (e.g., diffpy.org) are updated and + tested +- [ ] Successfully run any tutorial examples or do functional testing in some other way. +- [ ] Grammar and writing quality have been checked (no typos). + +Please mention @sbillinge when you are ready for release. Include any additional comments necessary, such as +version information and details about the pre-release. diff --git a/.github/workflows/build-wheel-release-upload.yml b/.github/workflows/build-wheel-release-upload.yml new file mode 100644 index 0000000..82dc17a --- /dev/null +++ b/.github/workflows/build-wheel-release-upload.yml @@ -0,0 +1,16 @@ +name: Release (GitHub/PyPI) + +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 + secrets: + PYPI_TOKEN: ${{ secrets.PYPI_TOKEN }} + PAT_TOKEN: ${{ secrets.PAT_TOKEN }} From 3066254790f9ad72caa0f02c2ae0718421259110 Mon Sep 17 00:00:00 2001 From: Caden Myers Date: Wed, 23 Oct 2024 11:01:25 -0400 Subject: [PATCH 2/5] readme --- README.rst | 21 ++++++++++++--------- 1 file changed, 12 insertions(+), 9 deletions(-) diff --git a/README.rst b/README.rst index 58f2269..ec2ab4d 100644 --- a/README.rst +++ b/README.rst @@ -74,17 +74,15 @@ The following creates and activates a new environment named ``diffpy.fourigui_en conda create -n diffpy.fourigui_env python=3 conda activate diffpy.fourigui_env -Then, to fully install ``diffpy.fourigui`` in our active environment, run :: +To confirm that the installation was successful, type :: - conda install diffpy.fourigui + python -c "import diffpy.fourigui; print(diffpy.fourigui.__version__)" -Another option is to use ``pip`` to download and install the latest release from -`Python Package Index `_. -To install using ``pip`` into your ``diffpy.fourigui_env`` environment, we will also have to install dependencies :: - - pip install -r https://raw.githubusercontent.com/diffpy/diffpy.fourigui/main/requirements/run.txt +The output should print the latest version displayed on the badges above. -and then install the package :: +If the above does not work, you can use ``pip`` to download and install the latest release from +`Python Package Index `_. +To install using ``pip`` into your ``diffpy.fourigui_env`` environment, type :: pip install diffpy.fourigui @@ -94,12 +92,17 @@ and run the following :: pip install . +Getting Started +--------------- + +You may consult our `online documentation `_ for tutorials and API references. + Support and Contribute ---------------------- `Diffpy user group `_ is the discussion forum for general questions and discussions about the use of diffpy.fourigui. Please join the diffpy.fourigui users community by joining the Google group. The diffpy.fourigui project welcomes your expertise and enthusiasm! -If you see a bug or want to request a feature, please `report it as an issue `_ and/or `submit a fix as a PR `_. You can also post it to the `Diffpy user group `_. +If you see a bug or want to request a feature, please `report it as an issue `_ and/or `submit a fix as a PR `_. You can also post it to the `Diffpy user group `_. Feel free to fork the project and contribute. To install diffpy.fourigui in a development mode, with its sources being directly used by Python From ba028350f0dca9d0be65ee95437da5b6d76d68d0 Mon Sep 17 00:00:00 2001 From: Caden Myers Date: Wed, 23 Oct 2024 11:01:38 -0400 Subject: [PATCH 3/5] readme --- README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.rst b/README.rst index ec2ab4d..ca21c31 100644 --- a/README.rst +++ b/README.rst @@ -71,7 +71,7 @@ To add "conda-forge" to the conda channels, run the following in a terminal. :: We want to install our packages in a suitable conda environment. The following creates and activates a new environment named ``diffpy.fourigui_env`` :: - conda create -n diffpy.fourigui_env python=3 + conda create -n diffpy.fourigui_env diffpy.fourigui conda activate diffpy.fourigui_env To confirm that the installation was successful, type :: From 78029e937979efe1bae9cc3258a4c46057d18b29 Mon Sep 17 00:00:00 2001 From: Caden Myers Date: Wed, 23 Oct 2024 11:04:35 -0400 Subject: [PATCH 4/5] news --- news/recutv2.rst | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 news/recutv2.rst diff --git a/news/recutv2.rst b/news/recutv2.rst new file mode 100644 index 0000000..d8dcba6 --- /dev/null +++ b/news/recutv2.rst @@ -0,0 +1,23 @@ +**Added:** + +* Add GitHub release workflow + +**Changed:** + +* + +**Deprecated:** + +* + +**Removed:** + +* + +**Fixed:** + +* Recut to group's package standard, fix installation + +**Security:** + +* From 8e43568c40ff220b828a17838eadb8d5b6d068ad Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Wed, 23 Oct 2024 15:05:45 +0000 Subject: [PATCH 5/5] [pre-commit.ci] auto fixes from pre-commit hooks --- README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.rst b/README.rst index ca21c31..9e85518 100644 --- a/README.rst +++ b/README.rst @@ -102,7 +102,7 @@ Support and Contribute `Diffpy user group `_ is the discussion forum for general questions and discussions about the use of diffpy.fourigui. Please join the diffpy.fourigui users community by joining the Google group. The diffpy.fourigui project welcomes your expertise and enthusiasm! -If you see a bug or want to request a feature, please `report it as an issue `_ and/or `submit a fix as a PR `_. You can also post it to the `Diffpy user group `_. +If you see a bug or want to request a feature, please `report it as an issue `_ and/or `submit a fix as a PR `_. You can also post it to the `Diffpy user group `_. Feel free to fork the project and contribute. To install diffpy.fourigui in a development mode, with its sources being directly used by Python