cordova-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "ASF GitHub Bot (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (CB-13543) Automate build/deploy for cordova-docs
Date Mon, 27 Nov 2017 18:09:00 GMT

    [ https://issues.apache.org/jira/browse/CB-13543?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16267162#comment-16267162
] 

ASF GitHub Bot commented on CB-13543:
-------------------------------------

audreyso closed pull request #760: CB-13543 : updated instructions/documentation around travis
build/dep…
URL: https://github.com/apache/cordova-docs/pull/760
 
 
   

This is a PR merged from a forked repository.
As GitHub hides the original diff on merge, it is displayed below for
the sake of provenance:

As this is a foreign pull request (from a fork), the diff is supplied
below (as it won't show otherwise due to GitHub magic):

diff --git a/doc/building-and-deploying-the-website.md b/doc/building-and-deploying-the-website.md
new file mode 100644
index 000000000..571c0071d
--- /dev/null
+++ b/doc/building-and-deploying-the-website.md
@@ -0,0 +1,20 @@
+## Building and Deploying (Automated)
+
+### Testing
+
+After you are finished developing and making your changes, make sure to test them. Run:
+
+	npm test
+
+`npm test` runs both [eslint] and [mocha] tests. If your tests pass, commit and push your
work to Github.
+
+### Travis 
+
+[Travis] automatically builds and publishes the website on every change. In [travis.yml](../.travis.yml),
Travis  installs required dependencies and runs the build script. Travis will build the full
website for you by running `gulp build --prod` under the hood. Travis also uses [SVN] to update,
copy, add, and commit the new changes over to the website. Committing to svn can only occur
once the commit has been merged to master. You can read more about is happening under the
hood with SVN [here](deploying-the-website.md). Travis also runs `npm test` and will notify
you if any of your `eslint` or `mocha` tests are failing. When Travis is done building and
deploying, send a pull request and ask for a review.
+
+**NOTE**: Committing to Travis might take a while (up to 1 hour), depending on the number
of files changed.
+
+[Travis]: https://travis-ci.org/
+[eslint]: https://eslint.org/
+[mocha]: https://mochajs.org/
+[SVN]: http://svnbook.red-bean.com/en/1.7/svn.intro.quickstart.html
\ No newline at end of file
diff --git a/doc/developing-the-website.md b/doc/developing-the-website.md
index 46f0e4e20..dbe98f734 100644
--- a/doc/developing-the-website.md
+++ b/doc/developing-the-website.md
@@ -13,5 +13,13 @@ Alternatively, to dynamically rebuild the site and refresh the browser
_when cha
     node_modules/.bin/gulp watch
 
 ### Next steps
+When you are done with developing, you can [build and deploy](building-and-deploying-the-website.md)
using the automated steps.
 
-When you are done with developing you can [build](building-the-website.md) and [deploy](deploying-the-website.md).
\ No newline at end of file
+You can also [build](building-the-website.md) and [deploy](deploying-the-website.md) manually.
In case Travis build breaks, you may want to build and deploy manually. 
+
+### Not covered by automated build and deploy
+* Travis doesn't auto pull in translation changes. Read more [here](translate.md).
+* Travis doesn't update latest (7.x) from dev version of docs. You will need to do this manually
using `gulp snapshot`. Read more [here](https://github.com/apache/cordova-docs/blob/master/gulpfile.js#L212).
+* Travis doesn't create a new version of the docs (future 8.x). Read more [here](https://github.com/apache/cordova-docs/tree/master/doc/README/en#generating-a-version-release).
+
+Of course, you could do all three of the above as commits. After you commit them, then Travis
will do the deploy.
\ No newline at end of file


 

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


> Automate build/deploy for cordova-docs
> --------------------------------------
>
>                 Key: CB-13543
>                 URL: https://issues.apache.org/jira/browse/CB-13543
>             Project: Apache Cordova
>          Issue Type: Improvement
>          Components: cordova-docs
>            Reporter: Audrey So
>            Assignee: Audrey So
>              Labels: enhancement, feature, in-progress, optimization
>
> Automate build/deploy for cordova-docs
> Cordova-docs should be built and published automatically on every change
> Replace jsihnt with eslint
> Update README.md & update instructions in docs to reflect changes
> https://issues.apache.org/jira/browse/CB-13162



--
This message was sent by Atlassian JIRA
(v6.4.14#64029)

---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@cordova.apache.org
For additional commands, e-mail: issues-help@cordova.apache.org


Mime
View raw message