Skip to content

Update documentation to include how to publish #235

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

Merged
MgenGlder merged 5 commits into from
Nov 3, 2021
Merged

Update documentation to include how to publish #235

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
d42e6a2
Add publishing documentation
MgenGlder Sep 30, 2021
0f66c7c
Remove version update
MgenGlder Sep 30, 2021
5b39ac9
Remove version update
MgenGlder Sep 30, 2021
9b36e97
Remove version update
MgenGlder Sep 30, 2021
5581eeb
Merge branch 'master' into mgenglder/update-documenation-on-how-to-pu…
MgenGlder Nov 3, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 12 additions & 1 deletion DEVELOPMENT.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,15 @@ You can run `cake docs:generate` to generate the docs folder with the documentat
NOTE: Current generating the docs seems throw a `ERR_INVALID_CALLBACK(callback);`.

# Run the examples
You can run the examples with the `npm run local-dev` command. This will spin up a local server where you can drag and drop filetypes and test functionality. You'll need `webpack`, `webpack-dev-server`, and `webpack-cli` for it to work. Make sure you check the file types before make a pull request to test that things are still working correctly.
You can run the examples with the `npm run local-dev` command. This will spin up a local server where you can drag and drop filetypes and test functionality. You'll need `webpack`, `webpack-dev-server`, and `webpack-cli` for it to work. Make sure you check the file types before make a pull request to test that things are still working correctly.

# Publish updates
1. Merge all the commits that are expected to be in the release
2. Locally, `git pull` the latest changes
3. Locally, run `npm version <major|minor|patch>` with the appropriate semantic versioning param for the published update.
4. Locally, `git push --tags`
5. In GitHub, go to releases, and click on the new tag
6. Add the description with all the commits that are part of the release
7. Save
8. Locally, run `npm publish`
9. Voila 🎉