automattic / vip-build-tools
A collection of helpful build scripts for the WordPress VIP staff.
Installs: 4 526
Dependents: 0
Suggesters: 0
Security: 0
Stars: 2
Watchers: 8
Forks: 2
Open Issues: 1
Requires
- erusev/parsedown: ^1.7
Requires (Dev)
- dev-master
- 1.2.0
- 1.1.0
- 1.0.9
- 1.0.8
- 1.0.7
- 1.0.6
- 1.0.5
- 1.0.4
- 1.0.3
- 1.0.2
- 1.0.1
- 1.0.0
- dev-vipdoc-519/add/support-release-prs
- dev-add/stale-issue-pr-bot
- dev-update/channel
- dev-update/debugging_logic
- dev-add/title_profix
- dev-fix/changelog-tag-id
- dev-fix/PIE-2760
- dev-fix/empty-changelog
- dev-add/post-status
- dev-add/changelog
This package is auto-updated.
Last update: 2025-06-26 04:46:06 UTC
README
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:
composer install
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 |
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_TOKEN
can be generated using a helper app like https://github.com/Automattic/node-wpcom-oauth (example instructions)
Usage Example
GITHUB_TOKEN="" CHANGELOG_POST_TOKEN="" CIRCLE_PROJECT_USERNAME="" CIRCLE_PROJECT_REPONAME="" php scripts/github-changelog.php \
--wp-endpoint=https://example.com/wp-json/wp/v2/posts \
--wp-status=draft \
--wp-tag-ids=1 \
--wp-categories=3 \
--link-to-pr=true \
--changelog-source=last-release