release-script - npm Package Compare versions

Comparing version 0.5.8 to 1.0.0

bin/release.js

@@ -76,4 +76,2 @@ #!/usr/bin/env node
 
-var defaultDryRun = configOptions.defaultDryRun !== 'false';
-
 //------------------------------------------------------------------------------
@@ -90,7 +88,5 @@ // command line options
   describe: 'Publish only documents'
-}).option('run', {
-  describe: 'Actually execute command'
 }).option('dry-run', {
   alias: 'n',
-  describe: 'With "defaultDryRun" option set this toggles "dry run" mode'
+  describe: 'This option toggles "dry run" mode'
 }).option('verbose', {
@@ -125,14 +121,4 @@ describe: 'Increased debug output'
 
-var dryRunMode = argv.dryRun || defaultDryRun;
-if (argv.run) {
-  dryRunMode = false;
-}
-if (dryRunMode) {
-  console.log('DRY RUN'.magenta);
-  if (defaultDryRun) {
-    console.log('------------------------------------------------------');
-    console.log('To actually run your command please add "--run" option'.yellow);
-    console.log('------------------------------------------------------');
-  }
-}
+var dryRunMode = argv.dryRun;
+if (dryRunMode) console.log('DRY RUN'.magenta);
 
@@ -373,3 +359,3 @@ if (argv.preid) console.log('"--preid" detected. Documents will not be published'.yellow);
           headers: {
-            'Authorization': 'token ' + githubToken,
+            Authorization: 'token ' + githubToken,
             'User-Agent': 'release-script (https://github.com/alexkval/release-script)'
@@ -376,0 +362,0 @@ }

CHANGELOG.md

@@ -0,1 +1,8 @@
+v1.0.0 - Wed, 13 Jan 2016 18:22:40 GMT
+--------------------------------------
+
+- [cd55fb8](../../commit/cd55fb8) [changed] make "actual running" by default
+
+
+
 v0.5.8 - Wed, 06 Jan 2016 17:01:45 GMT
@@ -2,0 +9,0 @@ --------------------------------------

package.json

 {
   "name": "release-script",
-  "version": "0.5.8",
+  "version": "1.0.0",
   "description": "Release tools for projects. From github repo to npm and bower packages",
@@ -14,8 +14,8 @@ "bin": {
   "scripts": {
-    "build": "rm -rf bin && babel src --out-dir bin && chmod +x ./bin/release.js",
+    "build": "rimraf bin && babel src --out-dir bin",
     "lint": "eslint .",
     "test": "npm run lint",
-    "patch": "bin/release.js patch --run",
-    "minor": "bin/release.js minor --run",
-    "major": "bin/release.js major --run"
+    "patch": "node bin/release.js patch",
+    "minor": "node bin/release.js minor",
+    "major": "node bin/release.js major"
   },
@@ -46,5 +46,6 @@ "repository": {
     "eslint": "^1.0.0",
-    "eslint-config-airbnb": "^0.1.0",
+    "eslint-config-airbnb": "^3.0.0",
     "eslint-plugin-react": "^3.3.2",
-    "mt-changelog": "^0.6.1"
+    "mt-changelog": "^0.6.1",
+    "rimraf": "^2.5.0"
   },
@@ -51,0 +52,0 @@ "dependencies": {

README.md

@@ -5,21 +5,5 @@ # release-script
 
+[![Build Status](https://travis-ci.org/AlexKVal/release-script.svg)](https://travis-ci.org/AlexKVal/release-script)
 
 ---
-##### Human factor
-
-**Because of human nature to make mistakes, by default this script runs in `dry mode`.
-It prevents `danger` steps (`git push`, `npm publish` etc) from accidental running.**
-
-**For actual running your command please add `--run` option.**
-
-*If you don't want this behavior you can add `"defaultDryRun": "false"` into your `package.json`.*
-```json
-"release-script": {
-  "defaultDryRun": "false"
-}
-```
-*Then you can use `--dry-run` option for checks.*
-
----
-
 #### Description
@@ -62,10 +46,7 @@
 
-#### Documents pages publishing
+#### Documentation pages publishing
 
-If your project compiles static documentation pages (as e.g. `React-Boostrap` does)
-and needs to publish them to standalone repo / hosting (via `git push`),
-you can do it the same way the `bower` package releasing done.
+If your project generates static documentation pages (as `React-Boostrap` does)
+and needs publishing them to a standalone repo (via `git push`), just create additional github repo for the documentation pages.
 
-Just create additional github repo for your static documents site.
-
 E.g. [react-bootstrap.github.io.git](https://github.com/react-bootstrap/react-bootstrap.github.io)
@@ -79,5 +60,5 @@
 ```
-Default folders for documents are:
-- `"docsRoot": "docs-built"` folder where the documents files will be built (by your custom building scripts)
-- `"tmpDocsRepo": "tmp-docs-repo"` temporary folder.
+Default folders for documentation pages are:
+- `"docsRoot": "docs-built"` folder where the files will be built to. (by your custom building script)
+- `"tmpDocsRepo": "tmp-docs-repo"` temporary folder. (for the release-script usage)
 
@@ -95,6 +76,6 @@ It is advised to add them both into `.gitignore`.
 
-If you need to publish only documents (say with some minor fixes),
-this is as simple as:
+If you need to publish only documentation pages (say with some minor fixes),
+you can do it this way:
 ```
-> release --only-docs --run
+> release --only-docs
 ```
@@ -105,3 +86,3 @@ In this case the `package.json` version will be bumped with `--preid docs` as `0.10.0` => `0.10.0-docs.0`.
 
-*Note: Documents are not published with pre-release version,
+*Note: Documentation pages are not published when you are releasing "pre-release" version,
 (i.e. when you run it with `--preid` option).*
@@ -114,12 +95,12 @@
 
-You can do it by this way:
+You can do it this way:
 ```
-> release 0.25.100 --preid pre --tag canary --run
+> release 0.25.100 --preid pre --tag canary
 or
-> npm run release 0.25.100 -- --preid pre --tag canary --run
+> npm run release 0.25.100 -- --preid pre --tag canary
 ```
 
-If your `preid` tag and npm tag name are the same, then you can just:
+If your `preid` tag and npm tag are the same, then you can just:
 ```
-> release 0.25.100 --preid beta --run
+> release 0.25.100 --preid beta
 ```
@@ -133,4 +114,4 @@ It will produce `v0.25.100-beta.0` and `npm publish --tag beta`.
 
-Say you want to publish to `npmjs` only the content of your `lib` folder.
-Then you can do it as simple as adding this option to your `package.json`
+Say you want to publish the content of your `lib` folder as an npm package's root folder.
+Then you can do it as simple as adding the following to your `package.json`
 ```json
@@ -151,3 +132,3 @@ "release-script": {
 ```
-then you can disable superfluous `npm run build` step running
+then you can prevent `npm run build` step from running
 by setting `'release-script'.skipBuildStep` option:
@@ -169,9 +150,7 @@ ```json
   - `default` value: `'tmp-bower-repo'`
-- `altPkgRootFolder` - the folder name for alternative npm package root folder
+- `altPkgRootFolder` - the folder name for alternative npm package's root folder
 
 It is advised to add `bowerRoot` and `tmpBowerRepo` folders to your `.gitignore` file.
 
-All options are optional.
-
-E.g.:
+Example:
 ```json
@@ -188,51 +167,48 @@ "release-script": {
 
-If you want this script to publish github releases,
-you can generate token https://github.com/settings/tokens for it
-and set `env.GITHUB_TOKEN` to it like this:
+If you need this script to publish github releases,
+you can generate a github token at https://github.com/settings/tokens
+and put it to `env.GITHUB_TOKEN` this way:
 ```sh
 > GITHUB_TOKEN="xxxxxxxxxxxx" && release-script patch
 ```
-or through your shell scripts
+or into your shell scripts
 ```sh
 export GITHUB_TOKEN="xxxxxxxxxxxx"
 ```
-You can set a custom message for release via `--notes` CLI option:
+You can set a custom message for github release via `--notes` CLI option:
 ```
-> release patch --notes "This is small fix" --run
+> release patch --notes "This is a small fix"
 ```
 
 
-#### This script does following steps:
+#### This script does the following steps:
 
 - ensures that git repo has no pending changes
-- ensures that git repo last version is fetched
+- ensures that the latest version is fetched
 - checks linting and tests by running `npm run test` command
-- does version bump, with `preid` if it is requested
+- does version bumping
 - builds all by running `npm run build` command
   - If there is no `build` script, then `release-script` just skips the `build` step.
-- if one of `[rf|mt]-changelog` is used in 'devDependencies', then changelog is generated
-- adds and commits changed `package.json` (and `CHANGELOG.md`, if used) files to git repo
-- adds git tag with new version (and changelog message, if used)
+- if one of `[rf|mt]-changelog` is used in 'devDependencies', then changelog is to be generated
+- adds and commits `package.json` with changed version and `CHANGELOG.md` if it's used
+- adds git tag with new version and changelog message if it's used
 - pushes changes to github repo
-- if github token is present, publishes release to GitHub, named as `<repo> vx.x.x`
-- if `--preid` tag set, then `npm publish --tag` command for npm publishing is used
-  - through `--tag` one can set `npm tag name` for the pre-release version (e.g. `alpha` or `canary`)
-  - othewise `--preid` value will be used
-- if `altPkgRootFolder` doesn't set it will just `npm publish [--tag]` as usual
-  - otherwise if `altPkgRootFolder` set then this script
-    - will `npm publish [--tag]` from the `altPkgRootFolder` folder
-    - with the custom version of `package.json` with removed `scripts` and `devDependencies`
-    - also it will remove the `altPkgRootFolder` part from the `main` file path
-- if `bowerRepo` field is present in the `package.json`, then it releases bower package:
-  - clones bower repo to local `tmpBowerRepo` temp folder. `git clone bowerRepo tmpBowerRepo`
-  - then it cleans up all but `.git` files in the `tmpBowerRepo`
-  - then copies all files from `bowerRoot` to `tmpBowerRepo`
-    - (that has to be generated with `npm run build`)
-  - then by `git add -A .` adds all bower distr files to the temporary git repo
-  - commits, tags and pushes the same as for the `npm` package.
-  - then deletes the `tmpBowerRepo` folder
-- id `docsRepo` field is present in the `package.json`, then it pushes builded documents to their repo.
-  It is done the same way as `bower` repo.
+- if github token is present the script publishes the release to the GitHub
+- if `--preid` tag set then `npm publish --tag` command for npm publishing is used
+  - with `--tag` option one can set `npm tag name` for a pre-release version (e.g. `alpha` or `canary`)
+  - otherwise `--preid` value will be used
+- if `altPkgRootFolder` isn't set it will just `npm publish [--tag]` as usual. Otherwise:
+  - the release-script will `npm publish [--tag]` from the inside `altPkgRootFolder` folder
+  - `scripts` and `devDependencies` will be removed from `package.json`
+- if `bowerRepo` field is present in the `package.json` then bower package will be released.
+  - the script will clone the bower repo to the `tmpBowerRepo` folder
+  - clean up all files but `.git` in the `tmpBowerRepo` folder
+  - copy all files from `bowerRoot` to `tmpBowerRepo` (they has to be generated by `npm run build`)
+  - add all files to the temporary git repo with `git add -A .`
+  - then it will commit, tag and push. The same as for the `npm` package.
+  - and at the end it will remove the `tmpBowerRepo` folder
+- if `docsRepo` option is set then documentation pages are being pushed to their repo.
+  It is done the same way as `bower` publishing process.
 
-If command line `--only-docs` option is set, then `github`, `npm` and `bower` publishing steps will be skipped.
+If `--only-docs` command line option is set then `github`, `npm` and `bower` publishing steps will be skipped.
 
@@ -245,3 +221,3 @@ ## Installation
 
-If you need `bower` releases too, then add `'release-script'.bowerRepo` into your `package.json` like this:
+If you need `bower` releases too then add `'release-script'.bowerRepo` into your `package.json`:
 ```json
@@ -253,33 +229,30 @@ "release-script": {
 
-Then you can release like that:
+If you have smth like that in your shell:
 ```sh
-> release patch --run
-> release minor --preid alpha --run
-```
-
-If you don't have smth like that in your shell:
-```sh
 # npm
 export PATH="./node_modules/.bin:$PATH"
 ```
-then you have to type the commands like this:
+or you had installed `release-script` globally via `npm install -g release-script`,
+then you can release your new versions this way:
 ```sh
-> ./node_modules/.bin/release minor --preid alpha --run
+> release patch
+or
+> release minor --preid alpha
 ```
 
-Or you just can install `release-script` globally.
+Otherwise you need to type in the commands this way:
+```sh
+> ./node_modules/.bin/release minor --preid alpha
+```
 
-You also can add some helpful `script` commands to your `package.json`,
-and because `npm` adds `node_modules/.bin` into `PATH` for running scripts automatically,
-you can add them just like that:
+You can as well add some helpful `script` commands to your `package.json`:
 ```json
 "scripts": {
     ...
-    "patch": "release patch --run",
-    "minor": "release minor --run",
-    "major": "release major --run",
-    "release-dry-run": "release patch"
+    "patch": "release patch",
+    "minor": "release minor",
+    "major": "release major"
 ```
 
-Also you can add it like this:
+And you can add it like this:
 ```json
@@ -290,10 +263,10 @@ "scripts": {
 ```
-And then you can run it like that:
+This way it became possible to run it like that:
 ```
-> npm run release minor -- --preid alpha --run
-> npm run release patch -- --notes "This is small fix --run"
-> npm run release major // for dry run
+> npm run release minor -- --preid alpha
+> npm run release patch -- --notes "This is small fix"
+> npm run release major --dry-run // for dry run
 etc
 ```
-_Notice: you have to add additional `--` before any `--option`. That way additional options will get straight to `release-script`._
+_Notice: You have to add additional double slash `--` before any `--option`. This way additional options get through to `release-script`._
 
@@ -300,0 +273,0 @@

New alerts

Environment variable access

Supply chain risk

Package accesses environment variables, which may be a sign of credential stuffing or data theft.

Found 1 instance in 1 package

Fixed alerts

Environment variable access

Supply chain risk

Package accesses environment variables, which may be a sign of credential stuffing or data theft.

Found 1 instance in 1 package

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Number of low quality alerts

0

decreased by-100%

Number of low supply chain risk alerts

1

decreased by-50%

Worsened metrics

Total package byte prevSize

33131

decreased by-3.03%

Dev dependency count

8

increased by14.29%

Lines of code

374

decreased by-3.36%

Number of lines in readme file

263

decreased by-9.31%

No dependency changes