This repository contains reusable GitHub Actions workflows for MikoPBX module development. It provides standardized processes for building, testing, and publishing MikoPBX modules.

• Automated versioning (X.YY format)
• GitHub Release creation
• Optional publishing to files.miko.ru and releases.mikopbx.com
• Docker-based build environment
• Composer dependencies handling
• Changelog generation

The extension-publish workflow accepts the following inputs:

For modules that don't require custom build steps, use this basic configuration:

Create .github/workflows/build.yml in your module repository:

name: Build and Publish

on:
  push:
    branches:
      - master
  workflow_dispatch:

jobs:
  build:
    uses: mikopbx/.github-workflows/.github/workflows/extension-publish.yml@master
    with:
      initial_version: "1.50"  # Set your module's initial version
    secrets: inherit # Automatically passes all available secrets

For modules requiring custom compilation or build steps, use the custom_build_steps parameter. This allows you to:

• Use Docker containers for isolated builds
• Compile binary components
• Run specific build tools
• Execute custom build scripts

jobs:
  build:
    uses: mikopbx/.github-workflows/.github/workflows/extension-publish.yml@master
    with:
      initial_version: "1.70"
      custom_build_steps: |
      cd $GITHUB_WORKSPACE/module
      make build
      chmod +x bin/

jobs:
  build:
  uses: mikopbx/.github-workflows/.github/workflows/extension-publish.yml@master
  with:
    initial_version: "1.70"
    custom_build_steps: |
    cd $GITHUB_WORKSPACE/module
    # Build custom Docker image
    docker build -t custom-builder -f Dockerfile.build .
    # Run compilation
    docker run --rm \
    -v $GITHUB_WORKSPACE/module:/build \
    -w /build \
    custom-builder \
    bash -c "make && make install"

jobs:
  build:
  uses: mikopbx/.github-workflows/.github/workflows/extension-publish.yml@master
  with:
    initial_version: "1.70"
    custom_build_steps: |
    cd $GITHUB_WORKSPACE/module
    # C++ compilation
    docker run --rm \
    -v $GITHUB_WORKSPACE/module:/build \
    -w /build \
    gcc:latest \
    bash -c "g++ -o bin/app src/main.cpp"
    # Go compilation
    docker run --rm \
    -v $GITHUB_WORKSPACE/module:/build \
    -w /build \
    golang:1.21 \
    bash -c "cd cmd && go build -o ../bin/tool"

Create or update module.json in your module's src directory:

{
  "name": "Your Module Name",
  "version": "1.50",
  "min_pbx_version": "2024.1.22",
  "release_settings": {
    "publish_release": true,   // Enable/disable publishing to files.miko.ru and releases.mikopbx.com
    "changelog_enabled": true, // Enable/disable changelog generation
    "create_github_release": true  // Enable/disable GitHub release creation
  }
}

When using custom build steps:

1. File Structure:

   • Place build-related files (Dockerfile.build, Makefile, etc.) in your module repository
   • Ensure compiled artifacts are placed in the correct location for packaging

2. Docker Considerations:

   • Use $GITHUB_WORKSPACE/module as the mount point for your module code
   • Clean up containers and images after use
   • Consider using Docker build cache for faster builds

3. Environment Variables:

   • Access to all GitHub Actions environment variables
   • Can pass additional variables to Docker containers

4. Best Practices:

   • Keep Dockerfiles in your module repository
   • Document build requirements clearly
   • Test custom build steps locally before committing

The workflow executes in this order:

1. Repository checkout
2. Module validation
3. Version management
4. Environment setup
5. Dependency handling
6. Custom build steps (if specified)
7. Package creation
8. Publishing and release

• OWNCLOUD_AUTH: Authentication for files.miko.ru
• MIKO_LIC_REST_VENDOR_ID: Vendor ID for releases.mikopbx.com
• MIKO_LIC_REST_API_KEY: API key for releases.mikopbx.com
• MIKO_LIC_HOSTNAME: MikoPBX release server hostname
• WEBDAV_ROOT: WebDAV root URL for files.miko.ru
• SHARE_API_URL: Share API URL for files.miko.ru

1. Versioning:

   • Uses X.YY format (e.g., 1.50, 1.51, 1.52)
   • Automatically increments minor version
   • Initial version is set in workflow file

2. Build Process:

   • Uses Docker container for consistent build environment
   • Handles Composer dependencies if enabled in module.json
   • Updates version in module.json

3. Release Process:

   • Creates GitHub release (if enabled)
   • If publish_release is true:
     • Uploads to files.miko.ru
     • Publishes to releases.mikopbx.com
   • Generates changelog (if enabled)

{
  "release_settings": {
    "publish_release": true,    // Enable/disable publishing to MikoPBX platforms
    "changelog_enabled": true,  // Enable/disable changelog generation
    "create_github_release": true  // Enable/disable GitHub release creation
  }
}

1. Fork the repository
2. Create a feature branch
3. Submit a pull request

Test your changes by referencing your branch in the module's workflow:

jobs:
  build:
    uses: mikopbx/.github-workflows/.github/workflows/extension-publish.yml@your-branch

Common issues and solutions:

1. Version not incrementing:

   • Check initial_version in workflow file
   • Verify previous releases on GitHub

2. Upload failures:

   • Verify organization secrets
   • Check module.json settings
   • Review action logs for specific errors

1. Secrets Configuration:

   • All secrets should be configured at the organization or repository level
   • Use secrets: inherit to automatically pass all secrets to the workflow
   • Ensure all required secrets are available before running the workflow

2. Custom Build Steps:

   • Executed after dependency handling and before package creation
   • Have access to full GitHub Actions environment
   • Can use Docker for isolated builds
   • Should place artifacts in the correct module directories

3. Working Directory:

   • Base: $GITHUB_WORKSPACE
   • Module: $GITHUB_WORKSPACE/module
   • Build artifacts should be placed in appropriate module directories

4. Environment:

   • Runner: Ubuntu latest
   • Docker support available
   • Full access to GitHub Actions environment variables

For issues or questions about:

• Workflow configuration: Open an issue in this repository
• Module-specific build problems: Open an issue in the module's repository

1. Create issues for bugs and feature requests
2. Submit pull requests with improvements
3. Follow existing code style and conventions

This project is licensed under the MIT License - see the LICENSE file for details.