Skip to content

Commit fe15b7d

Browse files
justinmayerjustinmayer
committed
Add Cruft & apply changes from upstream template
1 parent 39592fe commit fe15b7d

12 files changed

Lines changed: 220 additions & 36 deletions

‎.cruft.json‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
{
2+
"template": "https://github.com/getpelican/cookiecutter-pelican-plugin",
3+
"commit": "c961d0e4dbb0758b15f7102c6f5585660dd0551a",
4+
"checkout": null,
5+
"context": {
6+
"cookiecutter": {
7+
"plugin_name": "yaml-metadata",
8+
"repo_name": "yaml-metadata",
9+
"package_name": "yaml_metadata",
10+
"distribution_name": "pelican-yaml-metadata",
11+
"version": "2.1.0",
12+
"description": "Pelican plugin for YAML-formatted Markdown metadata headers",
13+
"authors": "{name = \"Carey Metcalfe\", email = \"carey@cmetcalfe.ca\"}, {name = \"Justin Mayer\", email = \"entroP@gmail.com\"}",
14+
"keywords": "\"pelican\", \"plugin\"",
15+
"readme": "README.md",
16+
"contributing": "CONTRIBUTING.md",
17+
"license": "MIT License|MIT",
18+
"repo_url": "https://github.com/pelican-plugins/yaml-metadata",
19+
"dev_status": "5 - Production/Stable",
20+
"tests_exist": false,
21+
"python_version": ">=3.11",
22+
"pelican_version": ">=4.5",
23+
"_template": "https://github.com/getpelican/cookiecutter-pelican-plugin",
24+
"_commit": "9fff5f77d0678218def8c081481d3ad3d66cd3c7"
25+
}
26+
},
27+
"directory": null
28+
}

‎.github/FUNDING.yml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
github: justinmayer
2+
liberapay: pelican

‎.github/ISSUE_TEMPLATE/---bug-report.md‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
---
2+
name: "\U0001F41E Bug Report"
3+
about: Did you find a bug?
4+
title: ''
5+
labels: bug
6+
assignees: ''
7+
8+
---
9+
10+
<!--
11+
Hi there! Thank you for discovering and submitting an issue.
12+
13+
Before you submit this, let’s make sure of a few things.
14+
Please make sure the following boxes are ticked if they are correct.
15+
If not, please try and fulfill them first.
16+
-->
17+
18+
<!-- Checked checkbox should look like this: [x] -->
19+
- [ ] I have read the [Filing Issues](https://docs.getpelican.com/en/latest/contribute.html#filing-issues) and subsequent “How to Get Help” sections of the documentation.
20+
- [ ] I have searched the [issues](https://github.com/pelican-plugins/yaml-metadata/issues?q=is%3Aissue) (including closed ones) and believe that this is not a duplicate.
21+
22+
<!--
23+
Once the above boxes are checked, if you are able to fill in the following list
24+
with your information, it would be very helpful for maintainers.
25+
-->
26+
27+
- **OS version and name**: <!-- Replace with version + name -->
28+
- **Python version**: <!-- Replace with version -->
29+
- **Pelican version**: <!-- Replace with version -->
30+
- **Link to theme**: <!-- Replace with link to the theme you are using -->
31+
- **Links to plugins**: <!-- Replace with list of links to plugins you are using -->
32+
- **Link to your site**: <!-- If available, replace with link to your site -->
33+
- **Link to your source**: <!-- If available, replace with link to relevant source repository -->
34+
- **Link to a [Gist](https://gist.github.com/) with the contents of your settings file**: <!-- If your source is not accessible, put Gist link here -->
35+
36+
## Issue
37+
<!--
38+
Now feel free to write your issue. Please avoid vague phrases like “[…] doesn’t work”.
39+
Be descriptive! Thanks again 🙌 ❤️
40+
-->

‎.github/ISSUE_TEMPLATE/---documentation.md‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
name: "\U0001F4DA Documentation"
3+
about: Did you find errors, problems, or anything unclear in the README/docs?
4+
title: ''
5+
labels: docs
6+
assignees: ''
7+
8+
---
9+
10+
<!--
11+
Hi there! Thank you for discovering and submitting an issue with our documentation.
12+
13+
Before you submit this, let’s make sure of a few things.
14+
Please make sure the following boxes are ticked if they are correct.
15+
If not, please try and fulfill them first.
16+
-->
17+
18+
<!-- Checked checkbox should look like this: [x] -->
19+
- [ ] I have searched the [issues](https://github.com/pelican-plugins/yaml-metadata/issues?q=is%3Aissue) (including closed ones) and believe that this is not a duplicate.
20+
21+
## Issue
22+
<!-- Now feel free to write your issue, but please be descriptive! Thanks again 🙌 ❤️ -->

‎.github/ISSUE_TEMPLATE/---enhancement-request.md‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
name: "\U0001F381 Feature Request"
3+
about: Do you have ideas for new features and improvements?
4+
title: ''
5+
labels: enhancement
6+
assignees: ''
7+
8+
---
9+
10+
<!--
11+
Hi there! Thank you for wanting to make Pelican better.
12+
13+
Before you submit this, let’s make sure of a few things.
14+
Please make sure the following boxes are ticked if they are correct.
15+
If not, please try and fulfill them first. The last one is optional but encouraged.
16+
-->
17+
18+
<!-- Checked checkbox should look like this: [x] -->
19+
- [ ] I have searched the [issues](https://github.com/pelican-plugins/yaml-metadata/issues?q=is%3Aissue) (including closed ones) and believe that this is not a duplicate.
20+
- [ ] I have searched the [Pelican documentation](https://docs.getpelican.com/) and believe that my question is not covered.
21+
- [ ] I am willing to lend a hand to help implement this feature. <!-- optional but encouraged -->
22+
23+
## Feature Request
24+
<!-- Now feel free to write your idea for improvement. Thanks again 🙌 ❤️ -->

‎.github/ISSUE_TEMPLATE/---everything-else.md‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
name: "\U0001F5C3 Everything Else"
3+
about: Do you have a question/issue that does not fall into any of the other categories?
4+
title: ''
5+
labels: question
6+
assignees: ''
7+
8+
---
9+
10+
<!--
11+
Describe your question/issue here. This space is meant to be used for general questions
12+
that are not bugs, feature requests, or documentation issues.
13+
Before you submit this, let’s make sure of a few things.
14+
Please make sure the following boxes are ticked if they are correct.
15+
If not, please try and fulfill them first.
16+
-->
17+
18+
<!-- Checked checkbox should look like this: [x] -->
19+
- [ ] I have searched the [issues](https://github.com/pelican-plugins/yaml-metadata/issues?q=is%3Aissue) (including closed ones) and believe that this is not a duplicate.
20+
- [ ] I have searched the [Pelican documentation](https://docs.getpelican.com/) and believe that my question is not covered.
21+
22+
## Issue
23+
<!-- Now feel free to write your issue, but please be descriptive! Thanks again 🙌 ❤️ -->

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Ref: https://help.github.com/en/github/building-a-strong-community/configuring-issue-templates-for-your-repository#configuring-the-template-chooser
2+
blank_issues_enabled: true
3+
contact_links:
4+
- name: '💬 Pelican IRC Channel on Freenode'
5+
url: https://kiwiirc.com/client/irc.freenode.net/?#pelican
6+
about: |
7+
Chat with the community, ask questions, and learn about best practices.

‎.github/pull_request_template.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Pull Request Checklist
2+
3+
Resolves: #issue-number-here <!-- Only if related issue *already* exists — otherwise remove this line -->
4+
5+
<!-- This is just a reminder about the most common mistakes. Please make sure that you tick all *appropriate* boxes. Also, please read our [contribution guide](https://docs.getpelican.com/en/latest/contribute.html#contributing-code) at least once — it will save you unnecessary review cycles! -->
6+
7+
- [ ] Ensured **tests pass** and (if applicable) updated functional test output
8+
- [ ] Conformed to **code style guidelines** by running appropriate linting tools
9+
- [ ] Added **tests** for changed code
10+
- [ ] Updated **documentation** for changed code
11+
12+
<!-- If you have *any* questions to *any* of the points above, just **submit and ask**! This checklist is here to *help* you, not to deter you from contributing! -->

‎.github/workflows/main.yml‎

Lines changed: 16 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,26 @@ name: build
22

33
on: [push, pull_request]
44

5+
env:
6+
PYTEST_ADDOPTS: "--color=yes"
7+
8+
permissions:
9+
contents: read
10+
511
jobs:
612
lint:
713
name: Lint
814
runs-on: ubuntu-latest
915

1016
steps:
11-
- uses: actions/checkout@v3
17+
- uses: actions/checkout@v5
18+
with:
19+
persist-credentials: false
1220

13-
- name: Set up PDM
14-
uses: pdm-project/setup-pdm@v3
21+
- name: Set up Python & PDM
22+
uses: pdm-project/setup-pdm@v4
1523
with:
16-
python-version: "3.10"
24+
python-version: "3.11"
1725

1826
- name: Install dependencies
1927
run: pdm install
@@ -33,26 +41,23 @@ jobs:
3341
id-token: write
3442

3543
steps:
36-
- uses: actions/checkout@v3
37-
with:
38-
token: ${{ secrets.GH_TOKEN }}
44+
- uses: actions/checkout@v5
3945

4046
- name: Set up Python
41-
uses: actions/setup-python@v4
47+
uses: actions/setup-python@v6
4248
with:
43-
python-version: "3.9"
49+
python-version: "3.11"
4450

4551
- name: Check release
4652
id: check_release
4753
run: |
48-
python -m pip install --upgrade pip
4954
python -m pip install autopub[github]
5055
autopub check
5156
5257
- name: Publish
5358
if: ${{ steps.check_release.outputs.autopub_release=='true' }}
5459
env:
55-
GITHUB_TOKEN: ${{ secrets.GH_TOKEN }}
60+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
5661
run: |
5762
autopub prepare
5863
autopub commit

‎.pre-commit-config.yaml‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ ci:
55
# See https://pre-commit.com/hooks.html for info on hooks
66
repos:
77
- repo: https://github.com/pre-commit/pre-commit-hooks
8-
rev: v4.6.0
8+
rev: v6.0.0
99
hooks:
1010
- id: check-added-large-files
1111
- id: check-ast
@@ -21,8 +21,8 @@ repos:
2121
- id: trailing-whitespace
2222

2323
- repo: https://github.com/astral-sh/ruff-pre-commit
24-
rev: v0.5.0
24+
rev: v0.15.12
2525
hooks:
26-
- id: ruff
26+
- id: ruff-check
2727
- id: ruff-format
2828
args: ["--check"]

0 commit comments

Comments
 (0)