@egjs/release-helper

@egjs/release-helper

How to use

$ release-helper [remote]

Need Scripts

• build
• demo:deploy

For lerna

package.json

• lernaHelperReleaseType: you can force update according to the releaseType when you update the version.
• lernaHelperPublishTag: You can force the tag to be set when npm publish.

{
  "version": "1.0.0-beta.0",
  "lernaHelperReleaseType": "prerelease",
  "lernaHelperPublish": "beta"
}

lerna.json

• lernaHelperOptions: lernaHelperOptions can add additional information when running the lerna-helper script.

{
  "lernaHelperOptions": {
    // If "release --type root" command is used, the commands of beforeReleaseScripts are executed.
    "beforeReleaseScripts": [
      "npm run packages:build",
      "npm run demo:build",
      "npm run deploy"
    ],
    // When the deploy command is used, the files in deployFileMap are moved and the dest folder is deployed.
    "deployFileMap": [
      {
        // Folder path to copy
        "basePath": "packages/core/dist",
        // Folder paths to be pasted
        "dists": [
            "demo/release/{{version}}/dist",
            "demo/release/latest/dist"
        ]
      }
    ],
  }
}

Usage: lerna-helper [options] [command]

Options:
  -h, --help           display help for command

Commands:
  deploy [options]     Deploy the files to gh-pages.
                       For the list of files to be deployed to gh-pages, use the deployFileMap property of lerna.json.
  release [options]    Creating changelogs, committing releases, adding tags, and creating github release notes are executed.
                       You can use the beforeReleaseScripts property of lerna.json to call commands before the release is executed.
  version              Updates the versions of packages that have version-changed local package as a dependency.
                       Using lernaHelperReleaseType in package.json will force the version incremented by the release type. The type follows the semver's ReleaseType.
  publish [options]    Publish lerna's packages to npm except private.
                       If you use lernaHelperPublishTag in package.json, you can force publish with beta tag.
  changelog [options]  Creates a changelog from the tagged version to the version in package.json.
  help [command]       display help for command

License

@egjs/release-helper is released under the MIT license.

Copyright (c) 2020-present NAVER Corp.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.