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

Extending the documentation to include the steps for publishing releases #6

Merged
merged 1 commit into from
Feb 15, 2023
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
41 changes: 39 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,9 +67,46 @@ The JavaScript package should now be built within the directory `dist/main.js`.

BrowseEverything is available under [the Apache 2.0 license](LICENSE).

## Releasing
## Publishing

_To be drafted_
### Testing Locally Using [verdaccio](https://verdaccio.org/)

Using `npm`:

```bash
$ npx verdaccio
$ npm login --scope my-company --registry http://localhost:4873/
# Then, within another terminal
$ npm set registry http://localhost:4873/ --location project
# Please ensure that the "version" property in package.json has been incremented to the next release version
$ npm publish
```

Using `yarn`:

```bash
$ yarn verdaccio
$ npm login --scope my-company --registry http://localhost:4873/
# Then, within another terminal
$ yarn publish --registry http://localhost:4873/ --patch
```

### Publishing Releases to [npm](https://www.npmjs.com/)

Using `npm`:

```bash
$ npm login
# Please ensure that the "version" property in package.json has been incremented to the next release version
$ npm publish
```

Using `yarn`:

```bash
$ yarn login
$ yarn publish --patch
```

## Contributing

Expand Down
13 changes: 10 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,11 +1,17 @@
{
"name": "my-library",
"version": "1.0.0",
"name": "parcel-browse-everything",
"version": "0.0.1",
"author": "jrgriffiniii <1443986+jrgriffiniii@users.noreply.github.com>",
"description": "",
"source": "src/index.ts",
"main": "dist/main.js",
"module": "dist/module.js",
"types": "dist/types.d.ts",
"prettier": "eslint-config-prettier",
"repository": {
"type": "git",
"url": "git://github.com/jrgriffiniii/parcel-browse-everything.git"
},
"scripts": {
"build": "parcel build",
"format": "prettier --write .",
Expand Down Expand Up @@ -33,7 +39,8 @@
"parcel": "^2.8.2",
"prettier-eslint": "^15.0.1",
"prettier-eslint-cli": "^7.1.0",
"ts-node": "^10.9.1"
"ts-node": "^10.9.1",
"verdaccio": "^5.21.1"
},
"dependencies": {
"@types/jest": "^29.2.4",
Expand Down
Loading