Skip to content
box

GitHub Action

package-deploy-bot

v1.1.9 Latest version

package-deploy-bot

box

package-deploy-bot

GitHub Action to release packages in multiple methods

Installation

Copy and paste the following snippet into your .yml file.

 
              
- name: package-deploy-bot

              
  uses: danitseitlin/[email protected]
Learn more about this action in danitseitlin/package-deployer

Choose a version

NPM Deploy bot 👉 Automate your deployment process!

⚡ Quick Start

Run npm install package-deployer

👏 Basic usage

Run deploy-pkg <package name> to deploy an automatic version locally. Here are available flags:

CLI argument Explanation
--npm-access-token The NPM access token. Required for NPM package deployments.
--npm-registry The NPM registry. Default: registry.npmjs.org
--npm-scope The NPM scope. The scope of the NPM package. Default: ''
--github-access-token The GitHub access token. Required for GitHub release deployments.
--github-owner The GitHub owner. Required for GitHub release deployments.
--github-repo The GitHub repo. Required for GitHub release deployments.
--pretty-print Printing data in a more "readable" format
--debug If to print debug logs
--dry-run If to release packages in a dry run

🔥 Integrate with GitHub actions

You can integrate with a GitHub action workflow using the 'package-deploy-bot' GitHub action:

deployment:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2
    - name: Setting up the environment
      run: npm install
    - name: Deploying version
      uses: ./
      with:
        pkg_name: package-deployer
        pkg_managers: '[github, npm]'
        npm_registry: registry.npmjs.org
        npm_access_token: ${{secrets.NPM_AUTH_TOKEN}}
        github_access_token: ${{secrets.G_AUTH_TOKEN}}
        dry_run: true
        debug: true
Parameters Explanation
package_managers A list of package deployments. i.e. '[github, npm]'. Available options are github, npm.
pkg_name The name of the package.
npm_access_token The NPM access token. Required for NPM package deployments.
npm_registry The NPM registry. Default: registry.npmjs.org
npm_scope The NPM scope. The scope of the NPM package. Default: ''
github_access_token The GitHub access token. Required for GitHub release deployments.
github_owner The GitHub owner. Required for GitHub release deployments.
github_repo The GitHub repo. Required for GitHub release deployments.
pretty_print Printing data in a more "readable" format
debug If to print debug logs
dry_run If to release packages in a dry run