Skip to content
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

Deploy docs to GH Pages #293

Merged
merged 3 commits into from
Feb 24, 2019
Merged

Deploy docs to GH Pages #293

merged 3 commits into from
Feb 24, 2019

Conversation

SterlingVix
Copy link

@SterlingVix SterlingVix commented Feb 14, 2019

I noticed that the README promised a docs page soon, and that the docs pages worked, but just needed serving.

I added a deploy script which runs gh-pages: https://github.com/tschaub/gh-pages#command-line-utility

When you enter npm run deploy it will regenerate the docs and push to the gh-pages branch. The docs files are then visible at https://lancedikson.github.io/bowser/docs (also linked in README.md).

I hope this helps. :)

PS - I noticed I had a failing test during my local build, but I didn't touch any source code, so I assume that's a false negative.

@coveralls
Copy link

Pull Request Test Coverage Report for Build 452

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 88.712%

Totals Coverage Status
Change from base Build 450: 0.0%
Covered Lines: 469
Relevant Lines: 484

💛 - Coveralls

@SterlingVix
Copy link
Author

@lancedikson (or any other maintainers): any questions or feedback on this?

I maybe should have mentioned it in the commit: I tested the gh-pages script by deploying the docs on my fork. Literally all I did locally was run npm run deploy. What I got (and what you will get @ https://lancedikson.github.io/bowser/docs) is:

https://sterlingvix.github.io/bowser/docs

image

@lancedikson
Copy link
Collaborator

Hi, @SterlingVix. Sorry for the silence. Sounds great, but I didn't have a chance to have a look at it. I'll try to review and release it at the beginning of the week.

@SterlingVix
Copy link
Author

Thanks @lancedikson , and no problem, of course. 😉 Please let me know if I can do anything to help.

Copy link
Collaborator

@lancedikson lancedikson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems fine, will merge soon

@lancedikson lancedikson merged commit bc8d932 into bowser-js:master Feb 24, 2019
@SterlingVix
Copy link
Author

@lancedikson - I may not have been clear, but, as the repo owner, you'll have to run npm run deploy at least once to regenerate the docs and get them hosted on github.

Once you npm run deploy, then our /docs links should look essentially the same:
You: https://lancedikson.github.io/bowser/docs
Me: https://sterlingvix.github.io/bowser/docs/

My apologies if that wasn't clear in the PR.

@lancedikson
Copy link
Collaborator

@SterlingVix, thanks, but yeah, I know how it works, it's just hadn't enough time to make a release with proper changelogs and everything. Will do that today :) Sorry for the delay.

@SterlingVix
Copy link
Author

No problem, hope I'm not bugging you! I'll leave it in your capable hands. 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants