Joomla Module Packaging Workflow Example

This article demonstrates how to use the GitHub Actions workflow for packaging and releasing a Joomla module using the Joomla Extension Packager composite action.

How to Use

1. Copy the following YAML workflow into your repository's .github/workflows/ directory (e.g., module-packager.yml).
2. Edit the with: section to match your module's details.
3. Push to your repository or trigger the workflow manually from the GitHub Actions tab.

Workflow Code

# Example workflow for a Joomla module
name: Package and Release Module

on:
  workflow_dispatch:

jobs:
  package:
    runs-on: ubuntu-latest
    permissions:
      contents: write
      pull-requests: write
    steps:
      - name: Checkout code
        uses: actions/checkout@v4
        with:
          fetch-depth: 0
          token: ${{ secrets.GH_PAT }}
      - name: Package Module
        uses: N6REJ/joomla-packager@2025.6.23
        id: packager
        with:
          extension-name: 'mod_example'
          extension-xml: 'mod_example.xml'
          extension-type: 'module'
          author: 'Your Name'
          copyright-holder: 'Your Company'
          copyright-start-year: '2024'
          github-token: ${{ secrets.GH_PAT }}

After the workflow runs, your packaged module ZIP and changelog will be available in the repository's Releases section.