search

parse-community / parse-php-sdk

The PHP SDK for Parse Platform
https://parseplatform.org/
Other
811 stars 346 forks source link

Pages autodeploy and phpdoc style enforcing #335

Closed montymxb closed 7 years ago

montymxb commented 7 years ago

This adds document-check to package.json to allow enforcement of phpdoc standards. This also modifies .travis.yml to run this check after the tests are done. Via document-check checkstyle.xml is checked for any errors, and if found will exit with code 1.

This also adds a deployment phase to automatically setup our gh-pages on each release, which must currently be done by hand. By enforcing document-check in 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.

codecov[bot] commented 7 years ago

Codecov Report

Merging #335 into master will not change coverage. The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #335   +/-   ##
=======================================
  Coverage   98.77%   98.77%           
=======================================
  Files          34       34           
  Lines        2696     2696           
=======================================
  Hits         2663     2663           
  Misses         33       33

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update b760ca3...ad917d5. Read the comment docs.

flovilmart commented 7 years ago

That's pretty cool! Wish we could enforce those org wide :)

montymxb commented 7 years ago

@flovilmart Yep, the api ref is published under gh-pages @ http://parseplatform.org/parse-php-sdk/namespaces/Parse.html. I've uploaded changes by hand before before, but this should be much better, especially with enforcement in place.

The one thing I still have is to setup a token for travis to be able to push up on the gh-pages branch. I'm going to ahead and set that up before this goes in. Other than that I think we're good, but I'll let you know if I need anything for setting it up deployment with travis.