Pages autodeploy and phpdoc style enforcing #335
Conversation
…deploy for api ref on gh-pages
Codecov Report
@@ Coverage Diff @@
## master #335 +/- ##
=======================================
Coverage 98.77% 98.77%
=======================================
Files 34 34
Lines 2696 2696
=======================================
Hits 2663 2663
Misses 33 33Continue to review full report at Codecov.
|
|
That's pretty cool! Wish we could enforce those org wide :) |
|
@flovilmart Yep, the api ref is published under The one thing I still have is to setup a token for travis to be able to push up on the |
* Added 'document-check' to add phpdoc checking during tests and added deploy for api ref on gh-pages * Wrapping filename in quotes * Moved bash out of package.json * Unescaping strings * Testing missing block comment * Fixing lint exception to expose phpdoc style issue * Restored class summary * removed comment
* Add ParsePolygon Type and polygonContains query * test class fix * error handling for polygon * Update PHP_CodeSniffer (#328) * Add lint * update travis * coding style * add coverage to gitignore * removed ignore lines * nit * Updated parse-php-sdk to version 1.2.9 * Corrects and updates phpdoc references/errors (#329) * Corrects and updates phpdoc references/errors * Lint fixes * Added 'Getting Started' to README.md Adds a **Getting Started** section to README.md to direct newcomers to the [official guide](http://docs.parseplatform.org/php/guide/) and [API reference](http://parseplatform.org/parse-php-sdk/namespaces/Parse.html). * Remove Default API (#332) * Removed default api and added appropriate checking * lint * Pages autodeploy and phpdoc style enforcing (#335) * Added 'document-check' to add phpdoc checking during tests and added deploy for api ref on gh-pages * Wrapping filename in quotes * Moved bash out of package.json * Unescaping strings * Testing missing block comment * Fixing lint exception to expose phpdoc style issue * Restored class summary * removed comment * fix documentation * Pinned jms/serializer to 1.7.1 (#336) * Pinned jms/serializer to 1.7.1 * Checking to update jms/serializer to 1.8.0 ONLY on php 5.4 for travis-ci * Added comment, and added graphviz for class diagrams in generated api docs
This adds
document-checkto package.json to allow enforcement of phpdoc standards. This also modifies .travis.yml to run this check after the tests are done. Viadocument-checkcheckstyle.xml is checked for any errors, and if found will exit with code1.This also adds a deployment phase to automatically setup our
gh-pageson each release, which must currently be done by hand. By enforcingdocument-checkin the existing test-suite we can be sure that our generated api reference is 💯 % and always up to date for each release.This will require a github token in order to function.
If there's an existing one we'll be good, right now it's just stubbed out from the docs. But if not we have the option of either passing it directly in this file or setting it up as an environment var. Either works, assuming this gets a go ahead.
There's a few other parameters that can be specified when deploying to pages, we could pass an email, name, etc. if desired.