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.

Sign up for GitHub

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

Jump to bottom

Add pre-publish hook to run jsdoc generation #4

Open
code-for-coffee opened this issue Dec 6, 2018 · 0 comments
Open

Add pre-publish hook to run jsdoc generation #4

code-for-coffee opened this issue Dec 6, 2018 · 0 comments
Labels
enhancement New feature or request good first issue Good for newcomers

Comments

@code-for-coffee
Copy link
Owner

I have setup Github pages to host the docs/ folder. It is located http://codeforcoffee.org/simple-state/.

Because npm publish is a manual task (no CI is setup for it currently) this project needs to have a pre-publish hook added using the npm script prepublishOnly (we do not want this running on every npm i, which will be triggered via prepublish). This way docs are always up to date whenever I publish a version to npm.

Related: https://docs.npmjs.com/misc/scripts
@code-for-coffee code-for-coffee added enhancement New feature or request good first issue Good for newcomers labels Dec 6, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@code-for-coffee