Skip to content

Commit 6be184e

Browse files
committed
Update cruft with batchpr
1 parent 48f4140 commit 6be184e

5 files changed

Lines changed: 108 additions & 22 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": "4268346dead7b529a3d53df19bcf374bb2bbef34",
3+
"commit": "fc4712d01764ac8bbe4b300dc754b3272449cff4",
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": "4268346dead7b529a3d53df19bcf374bb2bbef34"
35+
"_commit": "fc4712d01764ac8bbe4b300dc754b3272449cff4"
3636
}
3737
},
3838
"directory": null

.github/workflows/ci.yml

Lines changed: 38 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,11 @@ concurrency:
2020
group: ${{ github.workflow }}-${{ github.ref }}
2121
cancel-in-progress: true
2222

23+
permissions: {}
24+
2325
jobs:
2426
core:
25-
uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@v2
27+
uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@v2 # zizmor: ignore[unpinned-uses]
2628
with:
2729
submodules: false
2830
coverage: codecov
@@ -35,8 +37,10 @@ jobs:
3537
sdist_verify:
3638
runs-on: ubuntu-latest
3739
steps:
38-
- uses: actions/checkout@v6
39-
- uses: actions/setup-python@v6
40+
- uses: actions/checkout@v6 # zizmor: ignore[unpinned-uses]
41+
with:
42+
persist-credentials: false
43+
- uses: actions/setup-python@v6 # zizmor: ignore[unpinned-uses]
4044
with:
4145
python-version: '3.13'
4246
- run: python -m pip install -U --user build
@@ -46,7 +50,7 @@ jobs:
4650

4751
test:
4852
needs: [core, sdist_verify]
49-
uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@v2
53+
uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@v2 # zizmor: ignore[unpinned-uses]
5054
with:
5155
submodules: false
5256
coverage: codecov
@@ -63,7 +67,7 @@ jobs:
6367

6468
docs:
6569
needs: [core]
66-
uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@v2
70+
uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@v2 # zizmor: ignore[unpinned-uses]
6771
with:
6872
default_python: '3.13'
6973
submodules: false
@@ -98,7 +102,7 @@ jobs:
98102
secrets:
99103
CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
100104

101-
publish:
105+
build_dists:
102106
# Build wheels on PRs only when labelled. Releases will only be published if tagged ^v.*
103107
# see https://github-actions-workflows.openastronomy.org/en/latest/publish.html#upload-to-pypi
104108
if: |
@@ -108,12 +112,13 @@ jobs:
108112
contains(github.event.pull_request.labels.*.name, 'Run publish')
109113
)
110114
needs: [test, docs]
111-
uses: OpenAstronomy/github-actions-workflows/.github/workflows/publish_pure_python.yml@v2
115+
uses: OpenAstronomy/github-actions-workflows/.github/workflows/publish_pure_python.yml@v2 # zizmor: ignore[unpinned-uses]
112116
with:
113117
python-version: '3.13'
114118
test_extras: 'all,tests'
115119
test_command: 'pytest -p no:warnings --doctest-rst --pyargs ndcube'
116120
submodules: false
121+
<<<<<<<
117122
secrets:
118123
pypi_token: ${{ secrets.pypi_token }}
119124

@@ -129,3 +134,29 @@ jobs:
129134
homeserver: ${{ secrets.matrix_homeserver }}
130135
roomid: '!TWSJXVpyflnZOzmSQz:matrix.org'
131136
ignore_pattern: '.*Load tox.*'
137+
=======
138+
save_artifacts: true
139+
upload_to_pypi: false
140+
141+
publish:
142+
if: startsWith(github.ref, 'refs/tags/v')
143+
name: Upload to PyPI
144+
runs-on: ubuntu-latest
145+
needs: [build_dists]
146+
permissions:
147+
id-token: write
148+
environment:
149+
name: pypi
150+
steps:
151+
- name: Download artifacts
152+
uses: actions/download-artifact@v7 # zizmor: ignore[unpinned-uses]
153+
with:
154+
merge-multiple: true
155+
pattern: dist-*
156+
path: dist
157+
158+
- run: ls -lha dist/
159+
160+
- name: Run upload
161+
uses: pypa/gh-action-pypi-publish@v1 # zizmor: ignore[unpinned-uses]
162+
>>>>>>>

.github/workflows/sub_package_update.yml

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -13,18 +13,20 @@ on:
1313
# │ │ │ │ ┌───────── day of the week (0 - 6 or SUN-SAT)
1414
- cron: '0 7 * * 1' # Every Monday at 7am UTC
1515

16+
permissions: {}
17+
1618
jobs:
1719
update:
1820
runs-on: ubuntu-latest
1921
permissions:
2022
contents: write
2123
pull-requests: write
22-
strategy:
23-
fail-fast: true
2424
steps:
25-
- uses: actions/checkout@v6
25+
- uses: actions/checkout@v6 # zizmor: ignore[unpinned-uses]
26+
with:
27+
persist-credentials: false
2628

27-
- uses: actions/setup-python@v6
29+
- uses: actions/setup-python@v6 # zizmor: ignore[unpinned-uses]
2830
with:
2931
python-version: "3.14"
3032

@@ -50,8 +52,8 @@ jobs:
5052
id: cruft_update
5153
if: steps.check.outputs.has_changes == '1'
5254
run: |
53-
git config --global user.email "${{ github.actor }}@users.noreply.github.com"
54-
git config --global user.name "${{ github.actor }}"
55+
git config --global user.email "${GITHUB_ACTOR}@users.noreply.github.com"
56+
git config --global user.name "${GITHUB_ACTOR}"
5557
5658
cruft_output=$(cruft update --skip-apply-ask --refresh-private-variables)
5759
echo $cruft_output
@@ -77,7 +79,7 @@ jobs:
7779
7880
- name: Create pull request
7981
if: steps.cruft_json.outputs.has_changes == '1'
80-
uses: peter-evans/create-pull-request@v8
82+
uses: peter-evans/create-pull-request@v8 # zizmor: ignore[unpinned-uses]
8183
with:
8284
token: ${{ secrets.GITHUB_TOKEN }}
8385
add-paths: "."
@@ -103,7 +105,7 @@ jobs:
103105
issues: write
104106
steps:
105107
- name: Open an issue if workflow fails
106-
uses: actions/github-script@v7
108+
uses: actions/github-script@v7 # zizmor: ignore[unpinned-uses]
107109
with:
108110
github-token: ${{ github.token }}
109111
# This script is adapted from https://github.com/scientific-python/issue-from-pytest-log-action
@@ -151,7 +153,7 @@ jobs:
151153
repo: variables.name,
152154
body: issue_body,
153155
title: variables.title,
154-
labels: [variables.label],
156+
labels: [variables.label, "pre-commit.ci autofix"],
155157
});
156158
} else {
157159
await github.rest.issues.update({

.pre-commit-config.yaml

Lines changed: 25 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,56 @@
11
repos:
2+
- repo: https://github.com/zizmorcore/zizmor-pre-commit
3+
rev: v1.23.1
4+
hooks:
5+
- id: zizmor
26
# This should be before any formatting hooks like isort
37
- repo: https://github.com/astral-sh/ruff-pre-commit
48
rev: "v0.15.4"
59
hooks:
610
- id: ruff
711
args: ["--fix"]
12+
types: [python]
13+
# Define here once and then reference using YAML anchor
14+
exclude: &exclude_dirs ^ndcube/(data|extern)/
815
- repo: https://github.com/PyCQA/isort
916
rev: 8.0.1
1017
hooks:
1118
- id: isort
12-
exclude: ".*(.fits|.fts|.fit|.header|.txt|tca.*|extern.*|ndcube/extern)$"
19+
types: [python]
20+
exclude: *exclude_dirs
1321
- repo: https://github.com/pre-commit/pre-commit-hooks
1422
rev: v6.0.0
1523
hooks:
1624
- id: check-ast
25+
types: [python]
26+
exclude: *exclude_dirs
1727
- id: check-case-conflict
28+
types: [python]
29+
exclude: *exclude_dirs
1830
- id: trailing-whitespace
19-
exclude: ".*(.fits|.fts|.fit|.header|.txt)$"
31+
types_or: [python, rst]
2032
- id: check-yaml
33+
types: [yaml]
34+
exclude: *exclude_dirs
35+
- id: check-toml
36+
types: [toml]
37+
exclude: *exclude_dirs
2138
- id: debug-statements
39+
types: [python]
40+
exclude: *exclude_dirs
2241
- id: check-added-large-files
2342
args: ["--enforce-all", "--maxkb=1054"]
2443
- id: end-of-file-fixer
25-
exclude: ".*(.fits|.fts|.fit|.header|.txt|tca.*|.json)$|^CITATION.rst$"
44+
types_or: [python, rst]
2645
- id: mixed-line-ending
27-
exclude: ".*(.fits|.fts|.fit|.header|.txt|tca.*)$"
46+
types_or: [python, rst]
2847
- repo: https://github.com/codespell-project/codespell
2948
rev: v2.4.1
3049
hooks:
3150
- id: codespell
3251
args: [ "--write-changes" ]
52+
types_or: [python, rst]
53+
exclude: *exclude_dirs
3354
ci:
3455
autofix_prs: false
3556
autoupdate_schedule: "quarterly"

README.rst

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,43 @@
1+
<<<<<<<
12
ndcube
23
======
34

5+
=======
6+
A package for multi-dimensional contiguous and non-contiguous coordinate aware arrays.
7+
======================================================================================
8+
9+
Usage of Generative AI
10+
----------------------
11+
>>>>>>>
412
|Latest Version| |codecov| |matrix| |Powered by NumFOCUS| |Powered by SunPy|
513

614
.. |Latest Version| image:: https://img.shields.io/pypi/v/ndcube.svg
715
:target: https://pypi.python.org/pypi/ndcube/
816
:alt: It is up to date, we promise
17+
<<<<<<<
18+
=======
19+
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.
20+
For more information see our documentation on fair and appropriate `AI usage <https://docs.sunpy.org/en/latest/dev_guide/contents/ai_usage.html>`__.
21+
22+
Contributing
23+
------------
24+
25+
We love contributions! ndcube is open source,
26+
built on open source, and we'd love to have you hang out in our community.
27+
28+
If you would like to get involved, check out the `Developers Guide`_ section of the SunPy docs.
29+
Stop by our chat room `#sunpy:openastronomy.org`_ if you have any questions.
30+
Help is always welcome so let us know what you like to work on, or check out the `issues page`_ for the list of known outstanding items.
31+
32+
For more information on contributing to SunPy, please read our `Newcomers' guide`_.
33+
34+
.. _Developers Guide: https://docs.sunpy.org/en/latest/dev_guide/index.html
35+
.. _`#sunpy:openastronomy.org`: https://app.element.io/#/room/#sunpy:openastronomy.org
36+
.. _issues page: https://github.com/sunpy/ndcube/issues
37+
.. _Newcomers' guide: https://docs.sunpy.org/en/latest/dev_guide/contents/newcomers.html
38+
39+
When you are interacting with the SunPy community you are asked at to follow our `code of conduct <https://sunpy.org/coc>`__.
40+
>>>>>>>
941
.. |matrix| image:: https://img.shields.io/matrix/ndcube:openastronomy.org.svg?colorB=%23FE7900&label=Chat&logo=matrix&server_fqdn=openastronomy.modular.im
1042
:target: https://app.element.io/#/room/#ndcube:openastronomy.org
1143
:alt: join us on #ndcube:openastronom.org on matrix

0 commit comments

Comments
 (0)