diff --git a/.cruft.json b/.cruft.json index 3fe718f..b6f5855 100644 --- a/.cruft.json +++ b/.cruft.json @@ -1,6 +1,6 @@ { "template": "git@github.com:sunpy/package-template.git", - "commit": "75f84c4adf1753af67967930c3335bc73bca9bf5", + "commit": "3737aa309d2a695ada046c7868c5683213003f3d", "checkout": null, "context": { "cookiecutter": { @@ -10,6 +10,12 @@ "author_name": "SunPy Developers", "author_email": "sunpy@googlegroups.com", "project_url": "/~https://github.com/sunpy/sunkit-dem", + "github_repo": "", + "sourcecode_url": "", + "download_url": "https://pypi.org/project/sunkit-dem", + "documentation_url": "", + "changelog_url": "", + "issue_tracker_url": "", "license": "BSD 3-Clause", "minimum_python_version": "3.10", "use_compiled_extensions": "n", diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index eb2f08a..7594cf0 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -1,4 +1,4 @@ - +# Main CI Workflow name: CI on: @@ -22,7 +22,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 @@ -46,7 +46,7 @@ jobs: test: needs: [core, sdist_verify] - 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 @@ -61,7 +61,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 @@ -79,7 +79,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 @@ -100,7 +100,7 @@ jobs: contains(github.event.pull_request.labels.*.name, 'Run publish') ) needs: [test, docs] - uses: OpenAstronomy/github-actions-workflows/.github/workflows/publish_pure_python.yml@main + uses: OpenAstronomy/github-actions-workflows/.github/workflows/publish_pure_python.yml@v1 with: python-version: '3.12' test_extras: 'tests' diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index ec40e60..58c3d9f 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -1,7 +1,7 @@ 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"] diff --git a/.ruff.toml b/.ruff.toml index 80cf726..5f47414 100644 --- a/.ruff.toml +++ b/.ruff.toml @@ -22,7 +22,6 @@ extend-ignore = [ "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 _ "PT023", # Always use () on pytest decorators # flake8-pie (PIE) "PIE808", # Disallow passing 0 as the first argument to range diff --git a/docs/index.rst b/docs/index.rst index bdb1597..8ea5613 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -6,6 +6,15 @@ This is the documentation for sunkit-dem. .. toctree:: :maxdepth: 2 +<<<<<<< +======= + :caption: Contents: + + whatsnew/index + +Indices and tables +================== +>>>>>>> whatsnew/index reference/index diff --git a/pyproject.toml b/pyproject.toml index e46775d..17a8c73 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -33,13 +33,15 @@ tests = [ docs = [ "sphinx", "sphinx-automodapi", + "sphinx-changelog", "sunpy-sphinx-theme", "packaging", "sphinx_changelog", ] [project.urls] -repository = "/~https://github.com/sunpy/sunkit-dem" +Homepage = "/~https://github.com/sunpy/sunkit-dem" +Download = "https://pypi.org/project/sunkit-dem" [tool.setuptools] zip-safe = false @@ -108,6 +110,67 @@ write_to = "sunkit_dem/_version.py" name = "Documentation" showcontent = true +<<<<<<< +======= +[tool.setuptools_scm] +write_to = "sunkit_dem/_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//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//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//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 = "sunkit-dem" + filename = "CHANGELOG.rst" + directory = "changelog/" + issue_format = "`#{issue} https:github.com//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"