Skip to content

Commit 2483bbb

Browse files
committed
Update cruft with batchpr
1 parent 458266a commit 2483bbb

6 files changed

Lines changed: 140 additions & 20 deletions

File tree

.cruft.json

Lines changed: 3 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": "9599f755e4f7880fe20f0f07bbf500d8c41de34d",
44
"checkout": null,
55
"context": {
66
"cookiecutter": {
@@ -23,6 +23,7 @@
2323
"include_example_code": "n",
2424
"include_cruft_update_github_workflow": "y",
2525
"use_extended_ruff_linting": "y",
26+
"matrix_room_id": "",
2627
"_sphinx_theme": "sunpy",
2728
"_parent_project": "",
2829
"_install_requires": "",
@@ -32,7 +33,7 @@
3233
".github/workflows/sub_package_update.yml"
3334
],
3435
"_template": "https://github.com/sunpy/package-template",
35-
"_commit": "4268346dead7b529a3d53df19bcf374bb2bbef34"
36+
"_commit": "9599f755e4f7880fe20f0f07bbf500d8c41de34d"
3637
}
3738
},
3839
"directory": null

.github/dependabot.yml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
version: 2
2+
updates:
3+
- package-ecosystem: "github-actions"
4+
directory: "/"
5+
schedule:
6+
interval: "monthly"
7+
cooldown:
8+
default-days: 7

.github/workflows/ci.yml

Lines changed: 37 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,11 @@ concurrency:
2727
group: ${{ github.workflow }}-${{ github.ref }}
2828
cancel-in-progress: true
2929

30+
permissions: {}
31+
3032
jobs:
3133
core:
32-
uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@v2
34+
uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@v2 # zizmor: ignore[unpinned-uses]
3335
with:
3436
submodules: false
3537
coverage: codecov
@@ -43,8 +45,10 @@ jobs:
4345
sdist_verify:
4446
runs-on: ubuntu-latest
4547
steps:
46-
- uses: actions/checkout@v6
47-
- uses: actions/setup-python@v6
48+
- uses: actions/checkout@v6 # zizmor: ignore[unpinned-uses]
49+
with:
50+
persist-credentials: false
51+
- uses: actions/setup-python@v6 # zizmor: ignore[unpinned-uses]
4852
with:
4953
python-version: '3.13'
5054
- run: python -m pip install -U --user build
@@ -54,7 +58,7 @@ jobs:
5458

5559
test:
5660
needs: [core, sdist_verify]
57-
uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@v2
61+
uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@v2 # zizmor: ignore[unpinned-uses]
5862
with:
5963
submodules: false
6064
coverage: codecov
@@ -71,7 +75,7 @@ jobs:
7175

7276
docs:
7377
needs: [core]
74-
uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@v2
78+
uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@v2 # zizmor: ignore[unpinned-uses]
7579
with:
7680
default_python: '3.13'
7781
submodules: false
@@ -97,7 +101,7 @@ jobs:
97101
secrets:
98102
CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
99103

100-
publish:
104+
build_dists:
101105
# Build wheels on PRs only when labelled. Releases will only be published if tagged ^v.*
102106
# see https://github-actions-workflows.openastronomy.org/en/latest/publish.html#upload-to-pypi
103107
if: |
@@ -107,11 +111,35 @@ jobs:
107111
contains(github.event.pull_request.labels.*.name, 'Run publish')
108112
)
109113
needs: [test, docs]
110-
uses: OpenAstronomy/github-actions-workflows/.github/workflows/publish_pure_python.yml@v2
114+
uses: OpenAstronomy/github-actions-workflows/.github/workflows/publish_pure_python.yml@v2 # zizmor: ignore[unpinned-uses]
111115
with:
112116
python-version: '3.13'
113117
test_extras: 'tests'
114118
test_command: 'pytest -p no:warnings --doctest-rst --pyargs drms'
115119
submodules: false
116-
secrets:
117-
pypi_token: ${{ secrets.pypi_token }}
120+
save_artifacts: true
121+
upload_to_pypi: false
122+
123+
publish:
124+
if: startsWith(github.ref, 'refs/tags/v')
125+
name: Upload to PyPI
126+
runs-on: ubuntu-latest
127+
needs: [build_dists]
128+
permissions:
129+
id-token: write
130+
environment:
131+
name: pypi
132+
steps:
133+
- name: Download artifacts
134+
uses: actions/download-artifact@v8 # zizmor: ignore[unpinned-uses]
135+
with:
136+
merge-multiple: true
137+
pattern: dist-*
138+
path: dist
139+
140+
- run: ls -lha dist/
141+
142+
- name: Run upload
143+
uses: pypa/gh-action-pypi-publish@v1.13.0 # zizmor: ignore[unpinned-uses]
144+
145+

.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: "."
@@ -102,7 +104,7 @@ jobs:
102104
issues: write
103105
steps:
104106
- name: Open an issue if workflow fails
105-
uses: actions/github-script@v7
107+
uses: actions/github-script@v8 # zizmor: ignore[unpinned-uses]
106108
with:
107109
github-token: ${{ github.token }}
108110
# This script is adapted from https://github.com/scientific-python/issue-from-pytest-log-action
@@ -150,7 +152,7 @@ jobs:
150152
repo: variables.name,
151153
body: issue_body,
152154
title: variables.title,
153-
labels: [variables.label],
155+
labels: [variables.label, "pre-commit.ci autofix"],
154156
});
155157
} else {
156158
await github.rest.issues.update({

.pre-commit-config.yaml

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,85 @@
11
exclude: ".*(.fits|.fts|.fit|.header|.txt|tca.*|extern.*|drms/extern)$|^CITATION.rst$"
22

33
repos:
4+
<<<<<<<
5+
=======
6+
- repo: https://github.com/zizmorcore/zizmor-pre-commit
7+
rev: v1.23.1
8+
hooks:
9+
- id: zizmor
10+
# This should be before any formatting hooks like isort
11+
>>>>>>>
412
- repo: https://github.com/astral-sh/ruff-pre-commit
513
rev: "v0.15.4"
614
hooks:
715
- id: ruff
16+
<<<<<<<
817
args: ['--fix', '--unsafe-fixes']
918
- id: ruff-format
1019
- repo: https://github.com/PyCQA/isort
1120
rev: 8.0.1
1221
hooks:
1322
- id: isort
23+
=======
24+
args: ["--fix"]
25+
types: [python]
26+
# Define here once and then reference using YAML anchor
27+
exclude: &exclude_dirs ^drms/(data|extern)/
28+
>>>>>>>
1429
- repo: https://github.com/PyCQA/isort
1530
rev: 6.1.0
1631
hooks:
1732
- id: isort
33+
<<<<<<<
34+
=======
35+
types: [python]
36+
exclude: *exclude_dirs
37+
>>>>>>>
1838
- repo: https://github.com/pre-commit/pre-commit-hooks
1939
rev: v6.0.0
2040
hooks:
2141
- id: check-ast
42+
types: [python]
43+
exclude: *exclude_dirs
2244
- id: check-case-conflict
45+
types: [python]
46+
exclude: *exclude_dirs
2347
- id: trailing-whitespace
48+
<<<<<<<
49+
=======
50+
types_or: [python, rst]
51+
>>>>>>>
2452
- id: check-yaml
53+
types: [yaml]
54+
exclude: *exclude_dirs
55+
- id: check-toml
56+
types: [toml]
57+
exclude: *exclude_dirs
2558
- id: debug-statements
59+
types: [python]
60+
exclude: *exclude_dirs
2661
- id: check-added-large-files
2762
args: ["--enforce-all", "--maxkb=1054"]
2863
- id: end-of-file-fixer
64+
<<<<<<<
65+
=======
66+
types_or: [python, rst]
67+
>>>>>>>
2968
- id: mixed-line-ending
69+
<<<<<<<
70+
=======
71+
types_or: [python, rst]
72+
>>>>>>>
3073
- repo: https://github.com/codespell-project/codespell
3174
rev: v2.4.1
3275
hooks:
3376
- id: codespell
77+
<<<<<<<
78+
=======
79+
args: [ "--write-changes" ]
80+
types_or: [python, rst]
81+
exclude: *exclude_dirs
82+
>>>>>>>
3483
ci:
3584
autofix_prs: false
3685
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
====
3+
=======
4+
Access HMI, AIA and MDI data from the Standford JSOC DRMS
5+
=========================================================
6+
7+
Usage of Generative AI
8+
----------------------
9+
>>>>>>>
210
drms
311
====
412

513
Access HMI, AIA and MDI data from the Standford JSOC DRMS.
614

715
`Docs <https://docs.sunpy.org/projects/drms/>`__ |
816
`Tutorial <https://docs.sunpy.org/projects/drms/en/latest/tutorial.html>`__ |
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! drms 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/drms/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
`Github <https://github.com/sunpy/drms>`__ |
1042
`PyPI <https://pypi.org/project/drms/>`__
1143

0 commit comments

Comments
 (0)