-
Notifications
You must be signed in to change notification settings - Fork 668
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Docs: Add Travis CI + Azure Web App integration #1238
Changes from 1 commit
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
# Development flow integration | ||
|
||
`webhint` can be used at different steps of the development flow. The | ||
following is a guide that ilustrates some of this scenarios and how can | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. * illustrates There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. * these scenarios |
||
they be achieved. If you have another scenario that is not in here, please | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think 'they can' would read better than 'can they' here. |
||
open an issue [on webhint's GitHub repo][webhint github] so we can | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
|
||
investigate how to support it: | ||
|
||
* [Local server][local server]: Test a local instance of your website. | ||
* [Travis CI and Azure Web App][travis azure]: Publish to an staging | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. * a staging |
||
environment and automatically deploy to production if there are not any | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
|
||
problems. | ||
|
||
The recommended way to install `webhint` for all these scenarios is as a | ||
`devDependency` (`npm install hint --save-dev`) and that's what it's | ||
assumed in the guides. | ||
|
||
<!-- Link labels: --> | ||
|
||
[local server]: ./local-server.md | ||
[travis azure]: ./travis-and-azure.md | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Maybe have a Travis only case, without deploy, and just link to the specific part of There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. But how on travis? It could be a local server started during the build and then we will have to link to the local server document. |
||
[webhint github]: https://github.com/webhintio/hint/issues/new |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,16 +1,4 @@ | ||
# Development flow integration | ||
|
||
`webhint` can be used at different steps of the development flow. The | ||
following is a guide that ilustrates some of this scenarios and how can | ||
they be achieved. If you have another scenario that is not in here, please | ||
open an issue [on webhint's GitHub repo][webhint github] so we can | ||
investigate how to support it. | ||
|
||
The recommended way to install `webhint` for these scenarios is as a | ||
`devDependency` (`npm install hint --save-dev`) and that's what it's | ||
assumed here. | ||
|
||
## Test a local server | ||
# Test a local server | ||
|
||
In this scenario you want to run `webhint` against a local server that | ||
is running the code you want to test. Usually the tasks to perform can be | ||
|
@@ -56,7 +44,7 @@ and once it ends, kill the server started by `http-server`: | |
"scripts": { | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. [Up top, was committed before this PR] it's waiting -> it'll be waiting Add a comma after 'To solve this issue'. * simultaneously |
||
... | ||
"start": "http-server dist -s -g", | ||
"webhint": "^1.0.0", | ||
"hint": "^3.0.0", | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
|
||
"test": "npm build && npm-run-all -r -p http-server hint", | ||
... | ||
} | ||
|
@@ -72,3 +60,7 @@ and once it ends, kill the server started by `http-server`: | |
[npm scripts]: https://docs.npmjs.com/misc/scripts | ||
[npm-run-all]: https://www.npmjs.com/package/npm-run-all | ||
[webhint github]: https://github.com/webhintio/hint/issues/new | ||
[webhint repo]: https://github.com/webhintio/hint/ | ||
[webhintio repo]: https://github.com/webhintio/webhint.io/ | ||
|
||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Remove empty line. |
||
[webhint.io]: https://webhint.io |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That's more stylistic than anything else, right?