Producer
Producer is a command-line quality-assurance tool to validate, and then release,
your PHP library package. It supports Git and Mercurial for version control, as
well as Github, Gitlab, and Bitbucket for remote origins (including self-hosted
origins)., (*1)
Installing
Producer works in concert with Composer, PHPUnit, and PHPDocumentor.
Please install them first, either as part of your global system, or as part of
your package., (*2)
Global Install
To install Producer globally, issue composer global require producer/producer., (*3)
Be sure to add $COMPOSER_HOME/vendor/bin to your $PATH;
instuctions here., (*4)
Test the installation by issuing producer at the command line to see some
"help" output., (*5)
Remember, you will need PHPUnit and PHPDocumentor as well., (*6)
Package Install
To install the Producer package as a development requirement for your package issue composer require --dev producer/producer., (*7)
Test the installation by issuing ./vendor/bin/producer at the command line to
see some "help" output., (*8)
Remember, you will need PHPUnit and PHPDocumentor as well., (*9)
Configuring
Before you get going, you'll need to create a ~/.producer/config file. Copy
and paste the following into your terminal:, (*10)
mkdir ~/.producer
echo "; Github
github_username =
github_token =
; Gitlab
gitlab_token =
; Bitbucket
bitbucket_username =
bitbucket_password =" > ~/.producer/config
You can then edit ~/.producer/config to enter your access credentials, any or
all of:, (*11)
WARNING: Saving your username and password for Bitbucket in plain text is not
very secure. Bitbucket doesn't have personal API tokens, so it's either
"username and password" or bring in an external OAuth1 library with all its
dependencies just to authenticate to Bitbucket. The latter option might show
up in a subsequent release., (*12)
Package Configuration
Inside your package repository, you may define a .producer/config file that
sets any of the following options for that specific package., (*13)
; custom @package docblock value
package = Custom.Name
; custom hostnames for self-hosted origins
github_hostname = example.com
gitlab_hostname = example.net
bitbucket_hostname = example.org
; commands to use for phpunit and phpdoc
[commands]
phpunit = /path/to/phpunit
phpdoc = /path/to/phpdoc
; names for support files
[files]
changes = CHANGES.md
contributing = CONTRIBUTING.md
license = LICENSE.md
phpunit = phpunit.xml.dist
readme = README.md
Testing Systems: If you want to use a testing system other than PHPUnit,
you can set phpunit = /whatever/you/want. As long as it exits non-zero when
the tests fail, Producer will work with it properly. Yes, it was short-sighted
to name the key phpunit; a future release of Producer may remedy that., (*14)
Getting Started
Now that you have Producer installed and configured, change to the directory
for your library package repository. From there, you can call the following
commands:, (*15)
-
producer issues will show all the open issues from the remote origin
-
producer phpdoc will check the PHP docblocks in the src/ directory
-
producer validate <version> will validate the package for release, but won't
actually release it
-
producer release <version> will validate, and then actually release, the
package
NOTE: Producer reads the .git or .hg configuration data from the
repository, so it knows whether you are using Github, Gitlab, or Bitbucket
as the remote origin., (*16)
Validating
When you validate the library package, Producer will:, (*17)
- Sync with the remote origin (i.e., pull from the remote origin, then push any
local changes, then check the local status to make sure everything is
committed and pushed)
- Validate the composer.json file
- Check for informational files (see below) and for a
phpunit.xml.dist file
- Check that the license file has the current year in it
- Call
composer update, run the unit tests, and make sure they cleaned up after
- Check that the PHP docblocks in the
src/ directory are valid (see below)
- Check that the changes file is in the most-recent commit to the repository
If any of those fails, then the package is not considered valid for release., (*18)
In addition, the validate command will show any open issues from the remote
origin, but these are presented only as a reminder, and will not be considered
invalidators., (*19)
Producer wants you to have these informational files in the package root:, (*20)
-
CHANGES.md, a list of changes for the release;
-
CONTRIBUTING.md, describing how to contribute to the library;
-
LICENSE.md, the package licensing text; and,
-
README.md, an introduction to the library.
You may override these file names by setting the appropriate .producer/config
directives., (*21)
Docblocks
Producer will not attempt to check docblocks for 0.*, -dev, or -alpha releases.
It seems reasonable to expect that the codebase is not ready for documenting
before a beta release., (*22)
Releasing
When you release the package, Producer will first validate it as a pre-flight step., (*23)
Then it will use the Github or Gitlab API to create a release. In the case of
Bitbucket (which does not have an API for releases) it will tag the repository
locally., (*24)
Finally, Producer will sync with the remote origin so that the release is
represented locally, and/or pushed to the remote., (*25)
Wallogit.com
