Skip to content

Commit 6626199

Browse files
authored
chore(docs): add action/source documentation
1 parent eaf2b25 commit 6626199

File tree

1 file changed

+41
-0
lines changed

1 file changed

+41
-0
lines changed

docs/github_action.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -155,3 +155,44 @@ Example of report is in [this PR](https://github.com/vladopajic/go-test-coverage
155155
## Generate Coverage Badge
156156
157157
Instructions for badge creation are available [here](./badge.md).
158+
159+
160+
---
161+
162+
163+
# Advanced
164+
165+
## Types of GitHub Actions
166+
167+
The `go-test-coverage` project provides two types of GitHub Actions:
168+
169+
- **Binary-based Action (default)**
170+
171+
Executes the compiled binary using a Docker image. This is the default action, defined in [/action.yml](/action.yml).
172+
173+
Usage, as demonstrated throughout the documentation:
174+
```yml
175+
- name: check test coverage
176+
uses: vladopajic/go-test-coverage@v2
177+
with: ...
178+
```
179+
180+
- **Source-based Action (optional/experimental)**
181+
182+
Runs the source code using the `go run` command. This experimental action is defined in [/action/source/action.yml](/action/source/action.yml).
183+
184+
Usage:
185+
```yml
186+
- name: check test coverage
187+
# note: uses property adds 'action/source' part, compared to default action
188+
uses: vladopajic/go-test-coverage/action/source@v2
189+
with: ...
190+
```
191+
Note: this action requires `go` to be installed.
192+
193+
Both actions have the same inputs, so they can be used interchangeably.
194+
195+
196+
197+
198+

0 commit comments

Comments
 (0)