v3 Release Notes

Major Architecture Refactoring & Enhanced Features

Core Improvements

• Complete TypeScript Migration: Rewritten from JavaScript to TypeScript for enhanced type safety and developer experience
• Modular Architecture: Implemented separation of concerns with dedicated service layers and configuration management
• Input Validation: Robust validation system for all parameters with comprehensive error handling

New Features

• Cross-Repository Support: Create pull requests across different repositories within the same organization
• Enhanced Input Parameters: Added owner and repo inputs for flexible repository targeting
• Improved Error Handling: Detailed error messages and validation for branch conflicts and invalid inputs

Technical Enhancements

• Octokit Integration: Leverages GitHub's official REST API client for reliable PR operations
• Configuration Manager: Centralized input validation and configuration management
• Service Layer Architecture: Clean separation between business logic and GitHub API interactions

Breaking Changes

• New Required Inputs: owner and repo parameters are now mandatory
• Updated Output Structure: Consistent output formatting with proper TypeScript interfaces

Usage Example

- uses: ws2git/pr-spark@v3
  with:
    github-token: ${{ secrets.GITHUB_TOKEN }}
    owner: ${{ github.repository_owner }}
    repo: ${{ github.event.repository.name }}
    title: 'Automated PR'
    source-branch: 'feature-branch'
    dest-branch: 'main'

Upgrade Note: Review your workflows to include the new required owner and repo parameters for seamless migration to v3.

v2 Release: Enhanced Reliability and TypeScript Standards

This major maintenance release focuses on updating PR Spark's internal codebase to align with modern TypeScript and GitHub Actions best practices. The transition improves long-term reliability, provides superior debugging output, and ensures greater resilience against common workflow errors.

This is our updated stable release, tagged as v2.

Key Features

• Robust Codebase (TypeScript): Fully migrated to strong TypeScript standards, utilizing explicit function typing and modern asynchronous patterns (void run();), significantly reducing the risk of runtime errors.
• Structured Logging: Replaced standard console.log calls with core.info and core.setFailed. This provides clear, natively formatted, and actionable output in the GitHub Actions UI, making debugging straightforward.
• Resilient Input Handling: Implemented automatic trimming on all critical inputs (branches, title) to prevent silent failures and hidden whitespace errors common in dynamic workflows.
• Improved Error Safety: Enhanced error handling to differentiate between known exceptions and unknown issues, offering more accurate and useful failure messages.
• Maintainability: Parameter naming is now strict and explicit (head: sourceBranch, base: destBranch), improving code readability and future maintainability.

Getting Started

To leverage these stability enhancements, update the tag in your workflow file from v1 to v2.

- name: Create Pull Request
  uses: ws2git/pr-spark@v2
  with:
    github-token: ${{ secrets.GITHUB_TOKEN }}
    title: 'Auto Pull Request Deployment'
    body: 'Automated PR using the v2 stable release.'
    source-branch: 'develop'
    dest-branch: 'main'

We welcome your feedback and contributions to help us continue improving this action.

Automated Pull Request Creation

v1.0.1

Update action.yml

v1 Release: Automated Pull Request Creation

The first stable release of PR Spark, a GitHub Action designed to simplify your automated workflows. This action allows you to automatically create Pull Requests from one branch to another using a simple and efficient method.

This is our initial stable release, tagged as v1.

Key Features

• Effortless PR Creation: Create Pull Requests with a single step in your workflow.
• API-Based: Uses the official GitHub API to ensure robust and reliable operation.
• Fully Customizable: Set the PR title, body, source branch, and destination branch dynamically.
• Standard Token Support: Works seamlessly with the default secrets.GITHUB_TOKEN.

Getting Started

To add this action to your project, simply use the v1 tag in your workflow file.

- name: Create Pull Request
  uses: ws2git/pr-spark@v1
  with:
    github-token: ${{ secrets.GITHUB_TOKEN }}
    title: 'Auto Pull Request'
    body: 'Automated PR for deployment.'
    source-branch: 'develop'
    dest-branch: 'main'

We welcome your feedback and contributions to help us improve this action.