README.textile

July 16, 2025 ยท View on GitHub

h1. abc_plugin

"Download":https://github.com/gocom/abc_plugin/releases | "Packagist":https://packagist.org/packages/rah/abc_plugin

This is a plugin template for "Textpattern CMS":https://textpattern.com. 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.

h2. Cloning

This plugin template can be cloned, and forked, using "git":https://git-scm.com/:

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

h2. Development

For available commands, see:

bc. $ make help

h3. Composer support

Once a plugin created with this template is submitted to "Packagist":https://packagist.org repository, they can be installed through "Composer":https://getcomposer.org dependency manager from command-line:

bc. $ composer require rah/abc_plugin

h3. Compiling the plugin template

After cloning, the template can be compiled to a plugin installer package using "mtxpc":https://github.com/gocom/MassPlugCompiler, which is included as a development dependency and ran inside a Docker container:

bc. $ make compile

h2. Changelog

h3. Version 0.5.6 - 2025/07/16

  • Fix failing GitHub Actions by migrating from docker-compose command to docker compose.
  • Update composer image to version 2.8.
  • Update actions/checkout to version 4.
  • Update actions/upload-artifact to version 4.

h3. 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.

h3. Version 0.5.4 - 2022/11/19

  • Update actions/upload-artifact.

h3. Version 0.5.3 - 2022/11/19

  • Adjust GitHub release name.

h3. Version 0.5.2 - 2022/11/19

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

h3. Version 0.5.1 - 2022/11/19

  • Fix changelog quoting in GitHub Actions' workflow.

h3. 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.

h3. Version 0.4.0 - 2022/04/15

  • Use Docker containers for development environment.

h3. Version 0.3.0 - 2019/10/20

  • Fix textpack compilation.
  • Update to mtxpc 0.7.0.

h3. Version 0.2.0 - 2019/10/20

  • Update template.

h3. Version 0.1.0 - 2013/05/05

  • Initial release.