Skip to content

Commit dffac00

Browse files
committed
Update cruft with batchpr
1 parent 7c1b59f commit dffac00

5 files changed

Lines changed: 136 additions & 19 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/workflows/ci.yml

Lines changed: 59 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -35,9 +35,19 @@ jobs:
3535
- uses: hecrj/setup-rust-action@v2
3636
- run: cargo test
3737

38+
<<<<<<<
39+
=======
40+
permissions: {}
41+
42+
jobs:
43+
>>>>>>>
3844
core:
45+
<<<<<<<
3946
needs: [rust]
4047
uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@v2
48+
=======
49+
uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@v2 # zizmor: ignore[unpinned-uses]
50+
>>>>>>>
4151
with:
4252
submodules: false
4353
coverage: codecov
@@ -50,8 +60,10 @@ jobs:
5060
sdist_verify:
5161
runs-on: ubuntu-latest
5262
steps:
53-
- uses: actions/checkout@v6
54-
- uses: actions/setup-python@v6
63+
- uses: actions/checkout@v6 # zizmor: ignore[unpinned-uses]
64+
with:
65+
persist-credentials: false
66+
- uses: actions/setup-python@v6 # zizmor: ignore[unpinned-uses]
5567
with:
5668
python-version: '3.13'
5769
- run: python -m pip install -U --user build
@@ -60,8 +72,13 @@ jobs:
6072
- run: python -m twine check dist/*
6173

6274
test:
75+
<<<<<<<
6376
needs: [core, sdist_verify, rust]
6477
uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@v2
78+
=======
79+
needs: [core, sdist_verify]
80+
uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@v2 # zizmor: ignore[unpinned-uses]
81+
>>>>>>>
6582
with:
6683
submodules: false
6784
coverage: codecov
@@ -79,7 +96,7 @@ jobs:
7996

8097
docs:
8198
needs: [core]
82-
uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@v2
99+
uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@v2 # zizmor: ignore[unpinned-uses]
83100
with:
84101
default_python: '3.13'
85102
submodules: false
@@ -91,7 +108,7 @@ jobs:
91108
envs: |
92109
- linux: build_docs
93110
94-
publish:
111+
build_dists:
95112
# Build wheels on PRs only when labelled. Releases will only be published if tagged ^v.*
96113
# see https://github-actions-workflows.openastronomy.org/en/latest/publish.html#upload-to-pypi
97114
if: |
@@ -127,8 +144,46 @@ jobs:
127144
with:
128145
matrix_token: ${{ secrets.matrix_access_token }}
129146
github_token: ${{ secrets.GITHUB_TOKEN }}
147+
<<<<<<<
130148
homeserver: ${{ secrets.matrix_homeserver }}
131149
roomid: '!jfEXWJFdXwYnBWsiqk:openastronomy.org'
132150
ignore_pattern: '.*Load.*'
133151
summarise_success: true
134152
workflow_description: 'in sunpy/streamtracer'
153+
=======
154+
contains(github.event.pull_request.labels.*.name, 'Run publish')
155+
)
156+
needs: [test, docs]
157+
uses: OpenAstronomy/github-actions-workflows/.github/workflows/publish_pure_python.yml@v2 # zizmor: ignore[unpinned-uses]
158+
with:
159+
python-version: '3.13'
160+
test_extras: 'tests'
161+
test_command: 'pytest -p no:warnings --doctest-rst --pyargs streamtracer'
162+
submodules: false
163+
save_artifacts: true
164+
upload_to_pypi: false
165+
166+
publish:
167+
if: startsWith(github.ref, 'refs/tags/v')
168+
name: Upload to PyPI
169+
runs-on: ubuntu-latest
170+
needs: [build_dists]
171+
permissions:
172+
id-token: write
173+
environment:
174+
name: pypi
175+
steps:
176+
- name: Download artifacts
177+
uses: actions/download-artifact@v8 # zizmor: ignore[unpinned-uses]
178+
with:
179+
merge-multiple: true
180+
pattern: dist-*
181+
path: dist
182+
183+
- run: ls -lha dist/
184+
185+
- name: Run upload
186+
uses: pypa/gh-action-pypi-publish@v1.13.0 # zizmor: ignore[unpinned-uses]
187+
188+
189+
>>>>>>>

.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: 31 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,62 @@
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 ^streamtracer/(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.*|streamtracer/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+
<<<<<<<
53+
=======
54+
types_or: [python, rst]
55+
exclude: *exclude_dirs
56+
ci:
57+
autofix_prs: false
58+
autoupdate_schedule: "quarterly"
59+
>>>>>>>
3360
# Run mypy type validation
3461
- repo: https://github.com/pre-commit/mirrors-mypy
3562
rev: 'v1.10.0'

README.rst

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

5+
=======
6+
Python library to calculate streamlines
7+
=======================================
8+
9+
Usage of Generative AI
10+
----------------------
11+
>>>>>>>
412
Fast streamline tracing in python
513

614
|Documentation Status| |Build Status| |codecov|
715

816
Usage of Generative AI
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! streamtracer 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/streamtracer/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
----------------------
1042

1143
We expect authentic engagement in our community.

0 commit comments

Comments
 (0)