README

Download | Packagist

This is a plugin template for Textpattern CMS. This could be used as a template for other plugins. It includes Docker container runtime for PHP and Composer, plugin compiler and GitHub Actions integration which can automatically create compiled plugin releases, and run linter on commit.

This file would be your plugin’s help file.

Cloning

This plugin template can be cloned, and forked, using git:

$ git clone https://github.com/gocom/abc_plugin.git

Development

For available commands, see:

$ make help

Composer support

Once a plugin created with this template is submitted to Packagist repository, they can be installed through Composer dependency manager from command-line:

$ composer require rah/abc_plugin

Compiling the plugin template

After cloning, the template can be compiled to a plugin installer package using mtxpc, which is included as a development dependency and ran inside a Docker container:

$ make compile

Changelog

Version 0.5.5 – 2023/02/18

• Update release changelog extraction to convert Textile’s code formatting to Markdown syntax to avoid including false mentions in the release message.

Version 0.5.4 – 2022/11/19

• Update actions/upload-artifact.

Version 0.5.3 – 2022/11/19

• Adjust GitHub release name.

Version 0.5.2 – 2022/11/19

• Migrate to shogo82148/actions-create-release and shogo82148/actions-upload-release-asset actions.

Version 0.5.1 – 2022/11/19

• Fix changelog quoting in GitHub Actions’ workflow.

Version 0.5.0 – 2022/11/19

• Drop use of deprecated set-output command in command in GitHub Actions’ workflow file.
• Update actions/checkout to version 3.

Version 0.4.0 – 2022/04/15

• Use Docker containers for development environment.

Version 0.3.0 – 2019/10/20

• Fix textpack compilation.
• Update to mtxpc 0.7.0.

Version 0.2.0 – 2019/10/20

• Update template.

Version 0.1.0 – 2013/05/05

• Initial release.