Skip to content

Commit

Permalink
Update project with upstream plugin template changes
Browse files Browse the repository at this point in the history
  • Loading branch information
justinmayer committed Nov 3, 2024
1 parent d1857b0 commit 2be3152
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 6 deletions.
7 changes: 4 additions & 3 deletions .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@ on: [push, pull_request]
env:
PYTEST_ADDOPTS: "--color=yes"

permissions:
contents: read

jobs:
test:
name: Test - Python ${{ matrix.python-version }}
Expand Down Expand Up @@ -63,8 +66,6 @@ jobs:

steps:
- uses: actions/checkout@v4
with:
token: ${{ secrets.GH_TOKEN }}

- name: Set up Python
uses: actions/setup-python@v5
Expand All @@ -80,7 +81,7 @@ jobs:
- name: Publish
if: ${{ steps.check_release.outputs.autopub_release=='true' }}
env:
GITHUB_TOKEN: ${{ secrets.GH_TOKEN }}
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: |
autopub prepare
autopub commit
Expand Down
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ Sitemap

[![Build Status](https://img.shields.io/github/actions/workflow/status/pelican-plugins/sitemap/main.yml?branch=main)](https://github.com/pelican-plugins/sitemap/actions)
[![PyPI Version](https://img.shields.io/pypi/v/pelican-sitemap)](https://pypi.org/project/pelican-sitemap/)
[![Downloads](https://img.shields.io/pypi/dm/pelican-sitemap)](https://pypi.org/project/pelican-sitemap/)
![License](https://img.shields.io/pypi/l/pelican-sitemap?color=blue)

This [Pelican][] plugin generates a site map in plain-text or XML format. You can use the `SITEMAP` variable in your settings file to configure the behavior of the plugin.
Expand All @@ -14,6 +15,8 @@ This plugin can be installed via:

python -m pip install pelican-sitemap

As long as you have not explicitly added a `PLUGINS` setting to your Pelican settings file, then the newly-installed plugin should be automatically detected and enabled. Otherwise, you must add `sitemap` to your existing `PLUGINS` list. For more information, please see the [How to Use Plugins](https://docs.getpelican.com/en/latest/plugins.html#how-to-use-plugins) documentation.

Usage
-----

Expand Down
6 changes: 3 additions & 3 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ classifiers = [
"Framework :: Pelican",
"Framework :: Pelican :: Plugins",
"Intended Audience :: End Users/Desktop",
"License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)",
"License :: OSI Approved :: GNU Affero General Public License v3",
"Operating System :: OS Independent",
"Programming Language :: Python :: 3",
"Programming Language :: Python :: 3.9",
Expand Down Expand Up @@ -40,7 +40,7 @@ markdown = ["markdown>=3.4"]

[tool.pdm.dev-dependencies]
lint = [
"invoke>=2.2.0",
"invoke>=2.2",
"ruff>=0.7.2,<0.8.0",
]
test = [
Expand All @@ -56,7 +56,7 @@ source-includes = [
"CONTRIBUTING.md",
]
includes = ["pelican/"]
excludes = ["tasks.py"]
excludes = ["**/.DS_Store", "**/test_data/**", "tasks.py"]

[tool.autopub]
project-name = "Sitemap"
Expand Down

0 comments on commit 2be3152

Please sign in to comment.