https://github.com/vbem/kit.bash

An action provides general kit functions to improve user experience of bash 'run' steps
https://github.com/vbem/kit.bash

actions bash function github-actions kit run script source toolkit

Last synced: 3 days ago
JSON representation

An action provides general kit functions to improve user experience of bash 'run' steps

• Host: GitHub
• URL: https://github.com/vbem/kit.bash
• Owner: vbem
• License: apache-2.0
• Created: 2022-04-03T04:21:19.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2023-10-21T07:16:08.000Z (12 months ago)
• Last Synced: 2024-09-24T03:35:16.886Z (9 days ago)
• Topics: actions, bash, function, github-actions, kit, run, script, source, toolkit
• Language: Shell
• Homepage: https://github.com/marketplace/actions/kit-bash
• Size: 30.3 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
# kit.bash

[![Testing](https://github.com/vbem/kit.bash/actions/workflows/test.yml/badge.svg)](https://github.com/vbem/kit.bash/actions/workflows/test.yml)

[![Super Linter](https://github.com/vbem/kit.bash/actions/workflows/linter.yml/badge.svg)](https://github.com/vbem/kit.bash/actions/workflows/linter.yml)

[![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/vbem/kit.bash?label=Release&logo=github)](https://github.com/vbem/kit.bash/releases)

[![Marketplace](https://img.shields.io/badge/GitHub%20Actions-Marketplace-blue?logo=github)](https://github.com/marketplace/actions/kit-bash)

## About

This action provides general kit functions to improve user experience of bash 'run' steps.

## Example usage

```yaml

- uses: vbem/kit.bash@v1

  id: kit

- run: |

    ${{ steps.kit.outputs.source }} # Load kit.bash functions into current shell

    kit::log::stderr DEBUG 'This is a DEBUG message'

    kit::log::stderr INFO 'This is a INFO message'

    kit::log::stderr WANR 'This is a WARN message'

    kit::log::stderr ERROR 'This is a ERROR message'

    jq -Ce <<< '${{ toJson(steps) }}' | kit::wf::group 'Context "steps"'

    kit::wf::output 'some-output-name' <<< "some-output-value"

    kit::wf::env 'OS_RELEASE' < /etc/os-release

    kit::wf::summary <<< '### Hello world! :rocket:'

```

## Outputs

ID | Type | Description

--- | --- | ---

`entrypoint` | String | Path to 'kit.bash' entrypoint

`source` | String | Command to source 'kit.bash' entrypoint in current shell