https://github.com/gocom/action-textpattern-package-plugin

GitHub Action for automatically creating Textpattern CMS plugin packages
https://github.com/gocom/action-textpattern-package-plugin

textpattern textpattern-development

Last synced: 6 months ago
JSON representation

GitHub Action for automatically creating Textpattern CMS plugin packages

• Host: GitHub
• URL: https://github.com/gocom/action-textpattern-package-plugin
• Owner: gocom
• License: mit
• Created: 2019-10-12T12:42:59.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2022-11-18T22:33:05.000Z (about 3 years ago)
• Last Synced: 2025-04-14T10:55:13.889Z (10 months ago)
• Topics: textpattern, textpattern-development
• Language: PHP
• Homepage:
• Size: 16.6 KB
• Stars: 4
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
Package Textpattern CMS plugin GitHub Action

=====

This [GitHub Action](https://help.github.com/en/articles/about-github-actions) packages a source repository containing

a [Textpattern CMS](https://textpattern.com) plugin and creates installers.

Usage

-----

[Create a workflow file](https://help.github.com/en/articles/configuring-a-workflow) that checkouts your source code and builds it:

```yaml

name: Example Workflow

on: [push]

jobs:

  build:

    name: Build

    runs-on: ubuntu-latest

    steps:

    - name: Checkout

      uses: actions/checkout@v4

    - name: Build

      id: build

      uses: gocom/action-textpattern-package-plugin@master

    - name: Print Built Installers

      run: |

        cat ${{ github.workspace }}/${{ steps.build.outputs.compressed }}

        cat ${{ github.workspace }}/${{ steps.build.outputs.uncompressed }}

```

See [rah_flat](https://github.com/gocom/rah_flat) repository for live

[workflow examples](https://github.com/gocom/rah_flat/blob/master/.github/workflows), and

[releases](https://github.com/gocom/rah_flat/releases) containing uploaded plugin installers.

Input Arguments

-----

* **source**

  Path to the plugin source directory containing `manifest.json`. The path is relative to the repository root. Defaults

  to repository root directory.

* **output**

  Path to the output directory where build artifacts are saved to, relative to `$GITHUB_WORKSPACE`. Defaults to

  `build/packages`.

Output Variables

-----

* **name**

  The name of the built plugin.

* **version**

  The version number from the manifest file.

* **compressed**

  Path to the compressed plugin installer file, relative to `$GITHUB_WORKSPACE`.

* **uncompressed**

  Path to the uncompressed plugin installer file, relative to `$GITHUB_WORKSPACE`.