github-actions 0.0.2

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
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49

use std::env;
use std::fs::{File, OpenOptions};
use std::io::{self, Write};
use std::path::Path;

#[derive(Debug)]
pub enum SummaryError {
    VarError(env::VarError),
    FileError(io::Error),
}

fn clean_markdown_string(markdown_text: &str) -> String {
    markdown_text
        .replace("%25", "%")
        .replace("%0D", "\r")
        .replace("%0A", "\n")
        .to_string()
}

pub fn append_job_summary(markdown_text: &str) -> Result<(), SummaryError> {
    let summary_path =
        env::var(crate::GITHUB_STEP_SUMMARY).map_err(|err| SummaryError::VarError(err))?;
    let mut file = OpenOptions::new()
        .append(true)
        .open(summary_path)
        .map_err(|err| SummaryError::FileError(err))?;
    writeln!(file, "{}", clean_markdown_string(markdown_text))
        .map_err(|err| SummaryError::FileError(err))?;
    Ok(())
}

pub fn overwrite_job_summary(markdown_text: &str) -> Result<(), SummaryError> {
    let summary_path =
        env::var(crate::GITHUB_STEP_SUMMARY).map_err(|err| SummaryError::VarError(err))?;
    let mut file = File::create(summary_path).map_err(|err| SummaryError::FileError(err))?;
    writeln!(file, "{}", clean_markdown_string(markdown_text))
        .map_err(|err| SummaryError::FileError(err))?;
    Ok(())
}

pub fn remove_job_summary() -> io::Result<()> {
    if let Ok(summary_path) = env::var(crate::GITHUB_STEP_SUMMARY) {
        let path = Path::new(&summary_path);
        if path.exists() {
            std::fs::remove_file(path)?;
        }
    }
    Ok(())
}