Skip to content

Commit 17bf0af

Browse files
SunPyBotCadair
andauthored
Updates from package template (#120)
* Update cruft with batchpr * Update README.rst * Update README.rst --------- Co-authored-by: Stuart Mumford <stuart@cadair.com>
1 parent 47399ce commit 17bf0af

4 files changed

Lines changed: 11 additions & 17 deletions

File tree

.cruft.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"template": "https://github.com/sunpy/package-template",
3-
"commit": "164646d882aa2e972d305c54778aaaf35f707464",
3+
"commit": "4268346dead7b529a3d53df19bcf374bb2bbef34",
44
"checkout": null,
55
"context": {
66
"cookiecutter": {
@@ -32,7 +32,7 @@
3232
".github/workflows/sub_package_update.yml"
3333
],
3434
"_template": "https://github.com/sunpy/package-template",
35-
"_commit": "164646d882aa2e972d305c54778aaaf35f707464"
35+
"_commit": "4268346dead7b529a3d53df19bcf374bb2bbef34"
3636
}
3737
},
3838
"directory": null

.github/workflows/sub_package_update.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ jobs:
7777
7878
- name: Create pull request
7979
if: steps.cruft_json.outputs.has_changes == '1'
80-
uses: peter-evans/create-pull-request@v7
80+
uses: peter-evans/create-pull-request@v8
8181
with:
8282
token: ${{ secrets.GITHUB_TOKEN }}
8383
add-paths: "."
@@ -145,15 +145,15 @@ jobs:
145145
// If no issue is open, create a new issue,
146146
// else update the body of the existing issue.
147147
if (result.search.edges.length === 0) {
148-
github.rest.issues.create({
148+
await github.rest.issues.create({
149149
owner: variables.owner,
150-
repo: variables.n ame,
150+
repo: variables.name,
151151
body: issue_body,
152152
title: variables.title,
153153
labels: [variables.label],
154154
});
155155
} else {
156-
github.rest.issues.update({
156+
await github.rest.issues.update({
157157
owner: variables.owner,
158158
repo: variables.name,
159159
issue_number: result.search.edges[0].node.number,

.pre-commit-config.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
repos:
22
# This should be before any formatting hooks like isort
33
- repo: https://github.com/astral-sh/ruff-pre-commit
4-
rev: "v0.14.10"
4+
rev: "v0.15.4"
55
hooks:
66
- id: ruff
77
args: ["--fix"]
88
- repo: https://github.com/PyCQA/isort
9-
rev: 7.0.0
9+
rev: 8.0.1
1010
hooks:
1111
- id: isort
1212
exclude: ".*(.fits|.fts|.fit|.header|.txt|tca.*|extern.*|sunkit_magex/extern)$"

README.rst

Lines changed: 3 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -42,27 +42,21 @@ Help is always welcome, so come and say hello by joining the `SunPy Chat`_ and l
4242

4343
.. _Newcomers Guide: https://docs.sunpy.org/en/latest/dev_guide/contents/newcomers.html
4444
.. _Good First Issues list: https://github.com/sunpy/sunpy/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3A%22Good+First+Issue%22
45+
.. _SunPy Chat: https://app.element.io/#/room/#sunpy:openastronomy.org
4546

4647
Code of Conduct
4748
---------------
4849

4950
When you are interacting with the SunPy Community you are asked to follow our `Code of Conduct <https://sunpy.org/coc>`__.
5051

51-
.. _SunPy Chat: https://app.element.io/#/room/#sunpy:openastronomy.org
5252

5353
Usage of Generative AI
5454
----------------------
5555

5656
We expect authentic engagement in our community.
57-
Be wary of posting output from Large Language Models or similar generative AI as comments on GitHub or any other platform, as such comments tend to be formulaic and low quality content.
57+
**Do not post the output from Large Language Models or similar generative AI as code, issues or comments on GitHub or any other platform.**
5858
If you use generative AI tools as an aid in developing code or documentation changes, ensure that you fully understand the proposed changes and can explain why they are the correct approach and an improvement to the current state.
59-
60-
License
61-
-------
62-
63-
This project is Copyright (c) The SunPy Community and licensed under the terms of the GNU GPL v3+ license.
64-
This package is based upon the `Openastronomy packaging guide <https://github.com/OpenAstronomy/packaging-guide>`_ which is licensed under the BSD 3-clause license.
65-
See the licenses folder for more information.
59+
For more information see our documentation on fair and appropriate `AI usage <https://docs.sunpy.org/en/latest/dev_guide/contents/ai_usage.html>`__.
6660

6761
Contributing
6862
------------

0 commit comments

Comments
 (0)