You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/developing-for-pulsar/publishing.md
+16-37Lines changed: 16 additions & 37 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,39 +3,26 @@ title: Publishing
3
3
layout: doc.ejs
4
4
---
5
5
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.
11
7
12
8
See more in [Using PPM](/contributing-to-pulsar/using-ppm/).
13
9
14
10
15
11
There are a few things you should double check before publishing:
16
12
17
13
- 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:
26
20
`"engines": {"atom": ">=1.0.0 <2.0.0"}`.
27
-
- Your package is in a Git repository that has been pushed to
- 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.
30
22
31
23
## Publish your package
32
24
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.
39
26
40
27
Now, run the following commands from your package folder to publish it:
41
28
@@ -44,23 +31,17 @@ $ pulsar -p login
44
31
$ pulsar -p publish minor
45
32
```
46
33
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
49
35
50
36
`pulsar -p publish minor` command does:
51
37
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.
58
41
4. Pushes the tag and current branch up to GitHub.
59
42
5. Updates Pulsar Package Repository with the new version being published.
60
43
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.
64
45
65
46
#### Version increase type
66
47
@@ -79,8 +60,6 @@ where `type` can be `major`, `minor` and `patch`.
79
60
-**patch** version when you make backwards compatible bug fixes
80
61
- e.g. version `1.0.0` will become `1.0.1`
81
62
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.
84
64
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