Skip to content

Latest commit

 

History

History
72 lines (45 loc) · 3.18 KB

README.md

File metadata and controls

72 lines (45 loc) · 3.18 KB
Raw

Pelican Plugin CookieCutter Template

This project’s purpose is to make it easy to create new Pelican plugins via a CookieCutter template, as well as keeping generated plugins updated and in sync with template changes via Cruft.

Requirements

Option 1: Install Cruft via its installation instructions.

Option 2: Install Pipx and prefix the cruft commands below with: pipx run [...]

The latter option downloads and runs Cruft in a temporary environment. This is useful if you want to occasionally run Cruft but don’t need it frequently enough to install it on your computer.

Generate New Plugin from Template

To create a new Pelican plugin in the current working directory, enter the following command in your terminal console:

cruft create https://github.com/getpelican/cookiecutter-pelican-plugin

You will then be asked to fill in details about the new plugin. Many of the default values, shown in brackets, can be accepted by tapping the Return key, while other inputs such as the plugin name and authors must be explicitly entered via the respective interactive prompts. Alternatively, some values can be provided to the cruft invocation in JSON format, such as:

cruft create https://github.com/getpelican/cookiecutter-pelican-plugin --extra-context '{"plugin_name": "Render Math"}'

Continuous Deployment

The generated plugin contains a .github/workflows/main.yml file for continuous integration (CI) and deployment via GitHub Actions and AutoPub that will ensure tests pass, check code style compliance, and publish packaged distributions to PyPI when a RELEASE.md file is present. For the latter step to function properly, please first ask a Pelican maintainer to make the necessary “Trusted Publisher” changes in PyPI settings.

Add Cruft to Existing Project

  1. Ensure plugin template is up-to-date (linter versions, etc.). Commit and push any changes to the template repo.
  2. Run cruft create https://github.com/getpelican/cookiecutter-pelican-plugin to create a new project with the same name as the existing project.
  3. Enter the requested information when prompted, copy+pasting relevant info from the existing project.
  4. Diff-compare generated template to existing project, updating as needed to bring them into alignment.
  5. Commit those manual changes to the existing project.
  6. Copy generated .cruft.json file to the existing project, editing as necessary to ensure it is correct.
  7. Commit and push .cruft.json file.

Updating Existing Project via Cruft

Preparation:

cd ~/Projects/pelican-plugins/[PLUGIN-NAME]
git pull origin main
pdm update
inv tests
inv lint

Check:

cruft check   # or: inv cruft --check

Update:

cruft update  # or: inv cruft

See if anything broke:

pdm update
inv tests
inv lint

Add .cruft.json hash change and commit:

git add .cruft.json
git commit
git push