github-actions 0.0.3

Utilities for developing custom GitHub Actions
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33

# Github Actions

[![Crates.io](https://img.shields.io/crates/v/github-actions.svg)](https://crates.io/crates/github-actions)
[![Docs.rs](https://docs.rs/github-actions/badge.svg)](https://docs.rs/github-actions)
[![CI](https://img.shields.io/github/actions/workflow/status/daxartio/github-actions/ci.yml?branch=main)](https://github.com/daxartio/github-actions/actions)
[![Coverage Status](https://coveralls.io/repos/github/daxartio/github-actions/badge.svg?branch=main)](https://coveralls.io/github/daxartio/github-actions?branch=main)

A Rust crate for building GitHub Actions with ease, offering utilities to handle inputs, outputs, logging, and more.

## Features

- Parse inputs (`get_input`, `get_bool_input`, `get_multiline_input`).
- Manage GitHub Actions state (`get_state`, `save_state`).
- Log messages with various levels (`info!`, `debug!`, `warn!`, `error!`, `notice!`).
- Handle sensitive data with `set_secret`.
- Manage environment variables with `export_variable` and `add_path`.
- Control GitHub Actions commands (`stop_commands!`).
- Group logs for better readability (`group!`).
- Adding a job summary (`append_job_summary`, `overwrite_job_summary`, `remove_job_summary`)

## Installation

```
cargo add github-actions
```

## Documentation

For more detailed information, visit the [API Documentation](https://docs.github.com/en/actions/writing-workflows).

---

This crate simplifies interactions with GitHub Actions, enabling quick and clean integration into your Rust-based workflows.