Skip to content

Commit 2befdf9

Browse files
authored
Update README.md
1 parent 6a14afe commit 2befdf9

1 file changed

Lines changed: 35 additions & 0 deletions

File tree

README.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,36 @@
11
# GitHub Action Utils
2+
3+
### Example:
4+
5+
```python
6+
with group_context_manager("My Group"):
7+
set_output("test_var", "test_value")
8+
save_state("state", "val")
9+
10+
debug("Debug message")
11+
12+
warning(
13+
"Warning message", title="Warning Title", file="example.py",
14+
col=1, end_column=2, line=5, end_line=6,
15+
)
16+
warning("Another warning message")
17+
18+
error(
19+
"Error message", title="Error Title", file="example.py",
20+
col=1, end_column=2, line=1, end_line=2,
21+
)
22+
notice("Another notice message")
23+
24+
append_job_summary("# Hello World")
25+
append_job_summary("- Point 1")
26+
append_job_summary("- Point 2")
27+
```
28+
29+
#### Colorful Grouped Build Log Output
30+
![s3](https://user-images.githubusercontent.com/24854406/180003937-5839856e-09f9-47e7-8b62-f5126a78cad6.png)
31+
32+
#### Log Annotations and Build Summery
33+
![s2](https://user-images.githubusercontent.com/24854406/180003153-99434824-d08c-4a54-9a89-4c6163def1b2.png)
34+
35+
#### Log Annotations Associated with a File
36+
![s](https://user-images.githubusercontent.com/24854406/180003164-12735d03-a452-4bef-96a6-f1dc4298756e.png)

0 commit comments

Comments
 (0)