Download the PHP package automattic/vip-build-tools without Composer
On this page you can find all versions of the php package automattic/vip-build-tools. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Table of contents
Download automattic/vip-build-tools
More information about automattic/vip-build-tools
Files in automattic/vip-build-tools
Download automattic/vip-build-tools
More information about automattic/vip-build-tools
Files in automattic/vip-build-tools
Vendor automattic
Package vip-build-tools
Short Description A collection of helpful build scripts for the WordPress VIP staff.
License MIT
Package vip-build-tools
Short Description A collection of helpful build scripts for the WordPress VIP staff.
License MIT
Please rate this library. Is it a good library?
Informations about the package vip-build-tools
VIP Build Tools
A collection of helpful scripts to be used in CI jobs.
Prerequisites
Make sure you have composer installed.
Install
To get setup run the following command in the vip-build-scripts directory:
Script: Changelog
Extracts changelog information from the last closed Pull Request description and sends a request to a WordPress posts endpoint.
Options
| Option | Description | Required / Optional | Default Value |
|---|---|---|---|
| wp-endpoint | The WordPress posts endpoint the changelog will be posted at. | Required | |
| start-marker | The text marker used to find the start of the changelog description inside the PR description. | Optional | <h2>Changelog Description |
| end-marker | The text marker used to find the end of the changelog description inside the PR description. | Optional | <h2> |
| wp-status | The WordPress post status. | Optional | draft |
| wp-tag-ids | A comma separated list of WordPress tag ids to add to the post. | Optional | |
| link-to-pr | Whether or not to include the link to the PR in the post. | Optional | true |
| changelog-source | Source to create the changelog for. Use last-release to process release notes, otherwise processes last PR |
Optional | |
| wp-terms | Taxonomies and terms to add to the post. E.g. custom_taxonomy_slug:1,2 |
Optional | |
| changelog-title | Custom title format. Supports placeholders: {date}, {datetime}, {pr}, {version}, {repo} |
Optional | {repo} {datetime} |
Environment Variables
Most of these variables are already built-in by CircleCI.
| Option | Description | Required / Optional |
|---|---|---|
| CIRCLE_PROJECT_USERNAME | The GitHub username of the current project. | Required |
| CIRCLE_PROJECT_REPONAME | The name of the repository of the current project. | Required |
| CHANGELOG_POST_TOKEN | WordPress.com auth token required to post to the endpoint. | Required |
| GITHUB_TOKEN | The GitHub personal acess token needed to read private repositories. | Optional |
CHANGELOG_POST_TOKENcan be generated using a helper app like https://github.com/Automattic/node-wpcom-oauth (example instructions)
Usage Example
Custom Title Examples
The --changelog-title option supports the following placeholders:
{date}- Current date in YYYY-MM-DD format{datetime}- Current date and time in YYYY-MM-DD HH:MM format{pr}- Pull request number (when using default or last-pr source){version}- Release version tag (when using last-release source){repo}- Repository name
Examples:
All versions of vip-build-tools with dependencies
PHP Build Version
Package Version
Requires
erusev/parsedown Version
^1.7
The package automattic/vip-build-tools contains the following files
Loading the files please wait ...