Skip to content

Latest commit

 

History

History
55 lines (39 loc) · 1.65 KB

README.md

File metadata and controls

55 lines (39 loc) · 1.65 KB
Raw

Actions Toolkit

The GitHub Actions ToolKit provides an SDK to make creating actions easier in Python.

Downloads Pypi Versions Contributors

Installation

Action Toolkit is available on PyPI:

$ python -m pip install actions-toolkit

Action Toolkit officially supports Python 3.6+.

Usage

>>> import os
>>> from actions_toolkit import core
>>> os.environ['INPUT_NAME'] = 'Actions Toolkit'
>>> core.get_input('name', required=True)
'Actions Toolkit'
>>> core.error('Something went wrong.')
::error::Something went wrong.
>>> core.info('Run successfully.')
Run successfully.
>>> core.set_failed('SSL certificates installation failed.')
::error::SSL certificates installation failed.

For more examples and API documentation, please see the core & github.

Contributing

Contributions are always welcomed!

Here are the workflow for contributors:

  • Fork to your own
  • Clone fork to local repository
  • Create a new branch and work on it
  • Keep your branch in sync
  • Commit your changes (make sure your commit message concise)
  • Push your commits to your forked repository
  • Create a pull request

Please refer to CONTRIBUTING for detailed guidelines.

License

The scripts and documentation in this project are released under the MIT License.