/github-actions-badge

Generate GitHub Actions badge Markdown code.

Primary LanguageTypeScriptMIT LicenseMIT

github-actions-badge Actions Status: test

A command line tool that generate GitHub Actions badge Markdown code.

Install

Install with npm:

npm install github-actions-badge --global

Usage

Usage
  $ github-actions-badge

Options
  --format "markdown", "json"

Examples
  # Copy GitHub Action as Markdown format
  $ github-actions-badge | pbcopy

Example

$ github-actions-badge
[![Actions Status: test](https://github.com/azu/github-actions-badge/workflows/ci/badge.svg)](https://github.com/azu/github-actions-badge/actions?query=workflow%3Aci)

Changelog

See Releases page.

Running tests

Install devDependencies and Run npm test:

npm test

Contributing

Pull requests and stars are always welcome.

For bugs and feature requests, please create an issue.

  1. Fork it!
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -am 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request :D

Author

License

MIT © azu