Skip to content

Commit

Permalink
Update cruft with batchpr
Browse files Browse the repository at this point in the history
  • Loading branch information
Cadair committed Dec 6, 2024
1 parent 2cb2d2a commit a2aca18
Show file tree
Hide file tree
Showing 10 changed files with 194 additions and 17 deletions.
8 changes: 7 additions & 1 deletion .cruft.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"template": "https://github.com/sunpy/package-template",
"commit": "51fb616094a4d7577c8898445aa50effb89afa31",
"commit": "3737aa309d2a695ada046c7868c5683213003f3d",
"checkout": null,
"context": {
"cookiecutter": {
Expand All @@ -10,6 +10,12 @@
"author_name": "The SunPy Community",
"author_email": "[email protected]",
"project_url": "https://sunpy.org",
"github_repo": "sunpy/radiospectra",
"sourcecode_url": "https://github.com/sunpy/radiospectra",
"download_url": "https://pypi.org/project/sunraster",
"documentation_url": "https://docs.sunpy.org/projects/radiospectra",
"changelog_url": "https://docs.sunpy.org/projects/radiospectra/en/stable/whatsnew/changelog.html",
"issue_tracker_url": "https://github.com/sunpy/radiospectra/issues/",
"license": "BSD 2-Clause",
"minimum_python_version": "3.10",
"use_compiled_extensions": "n",
Expand Down
20 changes: 17 additions & 3 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
<<<<<<<
=======
# Main CI Workflow
>>>>>>>
name: CI

on:
Expand All @@ -21,7 +25,7 @@ concurrency:

jobs:
core:
uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@main
uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@v1
with:
submodules: false
coverage: codecov
Expand All @@ -45,8 +49,13 @@ jobs:
- run: python -m twine check dist/*

test:
<<<<<<<
needs: [core]
uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@main
=======
needs: [core, sdist_verify]
uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@v1
>>>>>>>
with:
submodules: false
coverage: codecov
Expand All @@ -61,7 +70,7 @@ jobs:

docs:
needs: [core]
uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@main
uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@v1
with:
default_python: '3.12'
submodules: false
Expand All @@ -80,7 +89,7 @@ jobs:
github.event_name == 'pull_request' &&
contains(github.event.pull_request.labels.*.name, 'Run cron CI')
)
uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@main
uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@v1
with:
default_python: '3.12'
submodules: false
Expand Down Expand Up @@ -118,8 +127,13 @@ jobs:
github.event_name == 'pull_request' &&
contains(github.event.pull_request.labels.*.name, 'Run publish')
)
<<<<<<<
needs: [test]
uses: OpenAstronomy/github-actions-workflows/.github/workflows/publish_pure_python.yml@main
=======
needs: [test, docs]
uses: OpenAstronomy/github-actions-workflows/.github/workflows/publish_pure_python.yml@v1
>>>>>>>
with:
python-version: "3.12"
test_extras: 'dev'
Expand Down
23 changes: 23 additions & 0 deletions .github/workflows/label_sync.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
name: Label Sync
on:
workflow_dispatch:
schedule:
# ┌───────── minute (0 - 59)
# │ ┌───────── hour (0 - 23)
# │ │ ┌───────── day of the month (1 - 31)
# │ │ │ ┌───────── month (1 - 12 or JAN-DEC)
# │ │ │ │ ┌───────── day of the week (0 - 6 or SUN-SAT)
- cron: '0 0 * * *' # run every day at midnight UTC

# Give permissions to write issue labels
permissions:
issues: write

jobs:
label_sync:
runs-on: ubuntu-latest
name: Label Sync
steps:
- uses: srealmoreno/label-sync-action@850ba5cef2b25e56c6c420c4feed0319294682fd
with:
config-file: https://raw.githubusercontent.com/sunpy/.github/main/labels.yml
4 changes: 4 additions & 0 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,11 @@
repos:
# This should be before any formatting hooks like isort
- repo: https://github.com/astral-sh/ruff-pre-commit
<<<<<<<
rev: "v0.7.2"
=======
rev: "v0.8.1"
>>>>>>>
hooks:
- id: ruff
args: ["--fix"]
Expand Down
51 changes: 39 additions & 12 deletions .ruff.toml
Original file line number Diff line number Diff line change
Expand Up @@ -16,29 +16,56 @@ select = [
"PT",
]
extend-ignore = [
# pycodestyle
# pycodestyle (E, W)
"E501", # ignore line length will use a formatter instead
"E712", # Avoid equality comparisons to True; use if {cond}: for truth checks
"E721", # type comparison Use is and is not for type comparisons, or isinstance() for isinstance checks
# upgrades
# pyupgrade (UP)
"UP038", # Use | in isinstance - not compatible with models and is slower
# pytest (PT)
"PT001", # Always use pytest.fixture()
"PT004", # Fixtures which don't return anything should have leading _
"PT011", # except(ValueRaises) is too broad
"PT023", # Always use () on pytest decorators
# flake8-pie
# flake8-pie (PIE)
"PIE808", # Disallow passing 0 as the first argument to range
# flake8-use-pathlib
# flake8-use-pathlib (PTH)
"PTH123", # open() should be replaced by Path.open()
# Ruff
# Ruff (RUF)
"RUF003", # Ignore ambiguous quote marks, doesn't allow ' in comments
"RUF012", # Mutable class attributes should be annotated with `typing.ClassVar`
"RUF013", # PEP 484 prohibits implicit `Optional`
"RUF015", # Prefer `next(iter(...))` over single element slice
"RUF012", # Mutable class attributes should be annotated with `typing.ClassVar`
"RUF013", # PEP 484 prohibits implicit `Optional`
"RUF015", # Prefer `next(iter(...))` over single element slice
]

[lint.per-file-ignores]
<<<<<<<
=======
"setup.py" = [
"INP001", # File is part of an implicit namespace package.
]
"conftest.py" = [
"INP001", # File is part of an implicit namespace package.
]
"docs/conf.py" = [
"E402" # Module imports not at top of file
]
"docs/*.py" = [
"INP001", # File is part of an implicit namespace package.
]
"examples/**.py" = [
"T201", # allow use of print in examples
"INP001", # File is part of an implicit namespace package.
]
"__init__.py" = [
"E402", # Module level import not at top of cell
"F401", # Unused import
"F403", # from {name} import * used; unable to detect undefined names
"F405", # {name} may be undefined, or defined from star imports
]
"test_*.py" = [
"E402", # Module level import not at top of cell
]

[lint.pydocstyle]
convention = "numpy"
>>>>>>>
"setup.py" = [
"INP001", # File is part of an implicit namespace package.
]
Expand Down
1 change: 1 addition & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@
"sphinx.ext.mathjax",
"sphinx_automodapi.automodapi",
"sphinx_automodapi.smart_resolver",
"sphinx_changelog",
]

# Set automodapi to generate files inside the generated directory
Expand Down
8 changes: 8 additions & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,14 @@ Contents
.. toctree::
:maxdepth: 2
:caption: Contents:
<<<<<<<
=======

whatsnew/index

Indices and tables
==================
>>>>>>>

installation
data_types/index
Expand Down
10 changes: 10 additions & 0 deletions docs/whatsnew/changelog.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
.. _changelog:

**************
Full Changelog
**************

.. changelog::
:towncrier: ../../
:towncrier-skip-if-empty:
:changelog_file: ../../CHANGELOG.rst
12 changes: 12 additions & 0 deletions docs/whatsnew/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
.. _whatsnew:

***************
Release History
***************

This page documents the releases for sunraster

.. toctree::
:maxdepth: 1

changelog
74 changes: 73 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -37,14 +37,20 @@ tests = [
docs = [
"sphinx",
"sphinx-automodapi",
"sphinx-changelog",
"sunpy-sphinx-theme",
"packaging",
"sphinx-changelog",
"sphinx-gallery",
]

[project.urls]
repository = "https://sunpy.org"
Homepage = "https://sunpy.org"
"Source Code" = "https://github.com/sunpy/radiospectra"
Download = "https://pypi.org/project/sunraster"
Documentation = "https://docs.sunpy.org/projects/radiospectra"
Changelog = "https://docs.sunpy.org/projects/radiospectra/en/stable/whatsnew/changelog.html"
"Issue Tracker" = "https://github.com/sunpy/radiospectra/issues/"

[tool.setuptools]
zip-safe = false
Expand Down Expand Up @@ -128,6 +134,72 @@ exclude = '''
| dist
| docs
| .history
<<<<<<<
)/
)
'''
=======

[tool.setuptools_scm]
write_to = "sunraster/_version.py"

[tool.gilesbot]
[tool.gilesbot.pull_requests]
enabled = true

[tool.gilesbot.towncrier_changelog]
enabled = true
verify_pr_number = true
changelog_skip_label = "No Changelog Entry Needed"
help_url = "https://github.com/sunpy/radiospectra/blob/main/changelog/README.rst"

changelog_missing_long = "There isn't a changelog file in this pull request. Please add a changelog file to the `changelog/` directory following the instructions in the changelog [README](https://github.com/sunpy/radiospectra/blob/main/changelog/README.rst)."

type_incorrect_long = "The changelog file you added is not one of the allowed types. Please use one of the types described in the changelog [README](https://github.com/sunpy/radiospectra/blob/main/changelog/README.rst)"

number_incorrect_long = "The number in the changelog file you added does not match the number of this pull request. Please rename the file."

# TODO: This should be in towncrier.toml but Giles currently only works looks in
# pyproject.toml we should move this back when it's fixed.
[tool.towncrier]
package = "sunraster"
filename = "CHANGELOG.rst"
directory = "changelog/"
issue_format = "`#{issue} https:github.com/sunpy/radiospectra/changelog/pull/{issue}>`__"
title_format = "{version} ({project_date})"

[[tool.towncrier.type]]
directory = "breaking"
name = "Breaking Changes"
showcontent = true

[[tool.towncrier.type]]
directory = "deprecation"
name = "Deprecations"
showcontent = true

[[tool.towncrier.type]]
directory = "removal"
name = "Removals"
showcontent = true

[[tool.towncrier.type]]
directory = "feature"
name = "New Features"
showcontent = true

[[tool.towncrier.type]]
directory = "bugfix"
name = "Bug Fixes"
showcontent = true

[[tool.towncrier.type]]
directory = "doc"
name = "Documentation"
showcontent = true

[[tool.towncrier.type]]
directory = "trivial"
name = "Internal Changes"
showcontent = true
>>>>>>>

0 comments on commit a2aca18

Please sign in to comment.