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

Update README and package.json publishing steps #250

Merged
merged 1 commit into from
Feb 5, 2024
Merged

Update README and package.json publishing steps #250

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 9 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,9 +127,15 @@ See [CONTRIBUTING.md](https://github.com/zooniverse/markdownz/tree/master/CONTRI

## Publishing

1. Add the new version to the changelog.
2. `npm version major|minor|patch` to test, build, push and publish a new version tag. https://github.com/zooniverse/markdownz/blob/a28604159282a20530c5e88625e0f4823485fa60/package.json#L17-L20
3. Publish a new tagged release on GitHub.
1. Create a new branch for the new version.
2. Add the new version to the changelog with summary of changes.
3. Update package.json and package-lock.json with the new version number (manually or with `npm --no-git-tag-version version [major|minor|patch]`).
4. Commit and push the changes to GitHub. Create a pull request, optionally have it reviewed, and merge it.
5. Using GitHub's web interface, create a new tag and release with the new version number and summary of changes.
6. Pull the new version of the package locally.
7. To clear any prior build (`./lib`), run tests, and create a fresh build, run `"rm -rf lib && npm test && npm run build"`.
8. Run `npm publish --dry-run` to check that the package is ready to publish.
9. Run `npm publish` to publish the new version to npm.

## License

Expand Down
5 changes: 1 addition & 4 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,7 @@
"build:esm": "BABEL_ENV=es6 babel src --out-dir lib/esm",
"lint": "eslint src",
"test": "mocha --require @babel/register test/helper.mjs test/*-test.js*",
"prepare": "npm run build",
"preversion": "rm -rf lib && npm test",
"version": "npm run build",
"postversion": "git push && git push --tags && npm publish"
"prepare": "npm run build"
},
"repository": {
"type": "git",
Expand Down