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

Documentation and cleaning up the publishing process #301

Merged
merged 2 commits into from
Mar 24, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
17 changes: 17 additions & 0 deletions PUBLISHING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Publishing a new version of this package

1. run `yarn publish`. This will ask you the new version, login into npm, build
the package, commit and tag before pushing to npm.
If you want to stop at any moment, you can ctrl-c, and depending on the moment,
you'll need to rollback manually.
2. On github, you need to edit the branch protection rules, and uncheck the
option "Do not allow bypassing the above settings".
3. Then you can push to github with the tags: `git push upstream HEAD --tags`. This
is the only case you're allowed to push directly to github.
4. Check the option "Do not allow bypassing the above settings" again.
5. On github, go to the tags page, then create a new release from the new tag
(this is an option in the "..." menu at the right).
6. Click "Generate releases notes" then follow the format of previous releases.



2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
"build:examples": "yarn clean:examples && yarn build:dev",
"build:dev": "cross-env BABEL_ENV=es6 webpack --config examples/webpack.config.js --progress --profile",
"start": "webpack serve --config examples/webpack.config.js",
"prepublishOnly": "yarn build"
"prepack": "yarn --frozen-lockfile && yarn build"
},
"author": "Vivek Kumar Bansal <[email protected]>",
"license": "MIT",
Expand Down