Download the PHP package gizra/robo-release-notes without Composer

On this page you can find all versions of the php package gizra/robo-release-notes. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of gizra/robo-release-notes

Informations about the package robo-release-notes

Robo Release Notes

Build Status Latest Stable Version Total Downloads License

A Robo task for generating comprehensive release notes from GitHub PRs and issues.

Features

Installation

Install via Composer:

Usage

Basic Setup

  1. Include the trait in your RoboFile.php:

  2. Set up environment variables:

Command Usage

Generate release notes from the latest tag:

Generate release notes from a specific tag:

Environment Variables

Variable Description Required
GITHUB_ACCESS_TOKEN GitHub personal access token with repo access Yes
GITHUB_USERNAME Your GitHub username Yes

To create a GitHub personal access token:

  1. Go to GitHub Settings → Developer settings → Personal access tokens
  2. Generate a new token with repo scope
  3. Copy the token and set it as an environment variable

Sample Output

How It Works

  1. Git Analysis: Scans git commits between the specified tag and HEAD
  2. PR Extraction: Uses regex patterns to extract PR numbers from commit messages
  3. GitHub API Calls: Fetches detailed PR and issue data from GitHub
  4. Issue Linking: Automatically links PRs to their associated issues using:
    • Closing keywords (fixes, closes, resolves)
    • Issue references in PR titles and descriptions
    • Issue numbers in branch names
  5. Data Aggregation: Combines all data into a structured release notes format

Testing

Run the test suite:

Run code style checks:

Fix code style issues:

Requirements

Advanced Configuration

Custom GitHub API Endpoint

For GitHub Enterprise users, you can extend the ReleaseNotesGenerator class and override the githubApiGet method to use a custom API endpoint.

Custom Output Format

You can extend the ReleaseNotesGenerator class and override the displayReleaseNotes method to customize the output format.

Contributing

  1. Fork the repository
  2. Create a feature branch
  3. Make your changes
  4. Add tests for new functionality
  5. Ensure all tests pass
  6. Submit a pull request

License

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

Support

Changelog

See CHANGELOG.md for a complete list of changes.

All versions of robo-release-notes with dependencies

PHP Build Version
Package Version
Requires php Version >=8.3
consolidation/robo Version ^3.0|^4.0|^5.0
ext-curl Version *
ext-json Version *
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package gizra/robo-release-notes contains the following files

Loading the files please wait ...