diff --git a/docs/publishing-a-package.md b/docs/publishing-a-package.md index fd5eaf952..9df1339f3 100644 --- a/docs/publishing-a-package.md +++ b/docs/publishing-a-package.md @@ -75,10 +75,15 @@ credentials are stored securely in your [keychain][keychain] once you login. :tada: Your package is now published and available on atom.io. Head on over to `http://atom.io/packages/my-package` to see your package's page. +With `apm publish`, you can bump the version and publish by using +```sh +apm publish +``` +where `` can be `major`, `minor` and `patch`. + The `major` option to the publish command tells apm to increment the first digit of the version before publishing so the published version will be `1.0.0` -and the Git tag created will be `v1.0.0`. Though since this might be your -first release, it's a good idea to keep to the `minor` release. +and the Git tag created will be `v1.0.0`. The `minor` option to the publish command tells apm to increment the second digit of the version before publishing so the published version will be `0.1.0` @@ -88,6 +93,10 @@ The `patch` option to the publish command tells apm to increment the third digit of the version before publishing so the published version will be `0.0.1` and the Git tag created will be `v0.0.1`. +Use `major` when you make a huge change, like a rewrite, or a large change to the functionality or interface. +Use `minor` when adding or removing a feature. +Use `patch` when you make a small change like a bug fix that does not add or remove features. + ### Further Reading * Check out [semantic versioning][semver] to learn more about versioning your