Skip to content

Commit 5b97810

Browse files
committed
pr remarks
1 parent 589075a commit 5b97810

File tree

1 file changed

+16
-37
lines changed

1 file changed

+16
-37
lines changed

docs/developing-for-pulsar/publishing.md

Lines changed: 16 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -3,39 +3,26 @@ title: Publishing
33
layout: doc.ejs
44
---
55

6-
Pulsar bundles a command line utility called `ppm` into every installation of
7-
Pulsar, to search for and install packages via the command line. This is invoked
8-
by using the `pulsar` command with the `-p` or `--package` option. The `pulsar -p`
9-
command can also be used to publish Pulsar packages to the public registry and
10-
update them.
6+
Pulsar bundles a command line utility called `ppm`, to search for and install packages via the command line. This can be invoked either by using the `pulsar` command with the `-p` or `--package` option or `ppm` directly. The `pulsar -p` command can also be used to publish Pulsar packages to the public registry and update them.
117

128
See more in [Using PPM](/contributing-to-pulsar/using-ppm/).
139

1410

1511
There are a few things you should double check before publishing:
1612

1713
- Your package has a `README.md` file at the root.
18-
- Your `package.json` file:
19-
- has `name` "URL Safe" field, as in it's not an emoji or special character.
20-
- has `description` field.
21-
- has `repository` field containing the URL of your repository.
22-
- has `version` field with a value of `"0.0.0"` before the first release, in
23-
any case it needs to be [Semver V2](https://semver.org/spec/v2.0.0.html)
24-
compliant.
25-
- has `engine` field that contains an entry for `atom` such as:
14+
- Your `package.json` file…
15+
- …has a “URL-safe” `name` field — without emoji or special characters.
16+
- …has a `description` field.
17+
- …has a `repository` field containing the URL of your repository.
18+
- …has a `version` field that is [Semver V2](https://semver.org/spec/v2.0.0.html) compliant and has a value of `"0.0.0"` before the first release.
19+
- has an `engine` field that contains an entry for `atom` such as:
2620
`"engines": {"atom": ">=1.0.0 <2.0.0"}`.
27-
- Your package is in a Git repository that has been pushed to
28-
[GitHub](https://github.com). Follow [this guide](https://help.github.com/articles/importing-a-git-repository-using-the-command-line/)
29-
if your package isn't already on GitHub.
21+
- Your package is in a Git repository that has been pushed to [GitHub](https://github.com). Follow [this guide](https://help.github.com/articles/importing-a-git-repository-using-the-command-line/) if your package isn't already on GitHub.
3022

3123
## Publish your package
3224

33-
Before you publish a package it is a good idea to check ahead of time if a
34-
package with the same name has already been published to
35-
[the Pulsar Package Repository](https://web.pulsar-edit.dev/packages). You can
36-
do that by visiting `https://web.pulsar-edit.dev/packages/your-package-name` to
37-
see if the package already exists. If it does, update your package's name to
38-
something that is available before proceeding.
25+
Before you publish a package, it is a good idea to check ahead of time if a package with the same name has already been published to [the Pulsar Package Repository](https://web.pulsar-edit.dev/packages). You can do that by visiting `https://web.pulsar-edit.dev/packages/your-package-name` to see if the package already exists. If it does, update your package's name to something that is available before proceeding.
3926

4027
Now, run the following commands from your package folder to publish it:
4128

@@ -44,23 +31,17 @@ $ pulsar -p login
4431
$ pulsar -p publish minor
4532
```
4633

47-
`pulsar -p login` will let you create and set an API token in your keychain to
48-
permit interacting with GitHub API
34+
`pulsar -p login` will let you create and set an API token in your keychain to permit interacting with GitHub API
4935

5036
`pulsar -p publish minor` command does:
5137

52-
1. Registers the package name on Pulsar Package Repository if it is being
53-
published for the first time.
54-
2. Updates the `version` field in the `package.json` file applying the `minor`
55-
version increase (details below) and commits it.
56-
3. Creates a new [Git tag](https://git-scm.com/book/en/Git-Basics-Tagging) for
57-
the version being published.
38+
1. Registers the package name on Pulsar Package Repository if it is being published for the first time.
39+
2. Updates the `version` field in the `package.json` file applying the `minor` version increase (details below) and commits it.
40+
3. Creates a new [Git tag](https://git-scm.com/book/en/Git-Basics-Tagging) for the version being published.
5841
4. Pushes the tag and current branch up to GitHub.
5942
5. Updates Pulsar Package Repository with the new version being published.
6043

61-
Your package is now published and available on Pulsar Package Repository. Head
62-
on over to `https://web.pulsar-edit.dev/packages/your-package-name` to see your
63-
package's page.
44+
Your package is now published and available on Pulsar Package Repository. Head on over to `https://web.pulsar-edit.dev/packages/your-package-name` to see your package's page.
6445

6546
#### Version increase type
6647

@@ -79,8 +60,6 @@ where `type` can be `major`, `minor` and `patch`.
7960
- **patch** version when you make backwards compatible bug fixes
8061
- e.g. version `1.0.0` will become `1.0.1`
8162

82-
Check out [semantic versioning](https://semver.org/) to learn more about best
83-
practices for versioning your package releases.
63+
Check out [semantic versioning](https://semver.org/) to learn more about best practices for versioning your package releases.
8464

85-
You can also run `pulsar -p help publish` to see all the available options and
86-
`pulsar -p help` to see all the other available commands.
65+
You can also run `pulsar -p help publish` to see all the available options and `pulsar -p help` to see all the other available commands.

0 commit comments

Comments
 (0)