Fast and smart. Update Tool checks for available software updates and creates pull requests.
 | The Update Tool is a lightweight collection of commands that know how to create pull requests from various data sources that inform us of the most recent available version of certain software components on our platform. These commands are executed periodically via `cron`, as managed by the Updatinator tool. |
The following commands are available:
- project:upstream:update: Given a repository that is a fork of an upstream repository, apply the changes from a newer tag.
There are two ways to provide authentication credentials when using the Update Tool commands.
- Environment variable: Define
GITHUB_TOKENwith the apporpriate personal access token. - On-disk cache: See update-tool.yml for the location to store the personal access token. Use the
--asoption to select between different cache locations.
The authentication credentials you will need can be found in the production Vault: secret/github/user__pantheon-upstream
Production: In production, this tool uses the credentials defined in the pantheon-systems/updatinator project.
Testing: GitHub Actions needs a GitHub token for a service account that has access to the projects in the test-configurations.yml fixtures file. Currently, the GitHub user pantheon-ci-bot is being used. Access it via:
pvault production read secret/github/access-tokens/pantheon-ci-bot
The pantheon-systems/updatinator project runs the automation processes in CircleCI 2.0 scripts.
Clone the GitHub repository and run composer install to get started.
The test suite may be run locally by way of some simple composer scripts:
| Test | Command |
|---|---|
| Run all tests | composer test |
| PHPUnit tests | composer unit |
| PHP linter | composer lint |
| Code style | composer cs |
| Fix style errors | composer cbf |
To release a new version of the Update Tool, create a new tag at the appropriate version. This will trigger the tests to run again. Assuming the tests pass, that sends a release dispatch that triggers another GitHub Action to publish the release and upload the update-tool.phar to the release.
Rebuild pantheon-systems/docker-updatinator to deploy a new version of the tool to the automation processes.
Alternately, you can use the Composer script composer release.
This will release a stable version of whatever is indicated in the VERSION file. e.g. if VERSION contains 1.0.3-dev, then version 1.0.3 will be tagged and released, and the VERSION file will be updated to 1.0.4-dev. To release version 1.1.0 instead, manually edit the VERSION file to 1.1.0-dev and then run composer release. This requires maintaining the VERSION file which historically has not been consistently updated, and simply creating the tag and allowing automation to handle the release is a more straightforward process.