Skip to content

Commit 79a274c

Browse files
committed
docs(local-actions): enhance description
Signed-off-by: Emilien Escalle <emilien.escalle@escemi.com>
1 parent 03a5a2a commit 79a274c

2 files changed

Lines changed: 6 additions & 33 deletions

File tree

actions/local-actions/README.md

Lines changed: 3 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -9,33 +9,6 @@
99
---
1010

1111
<!-- header:end -->
12-
13-
## Overview
14-
15-
Action to expose sibling local actions next to the current action directory.
16-
It creates a symlink to the parent actions directory at `../self-actions` relative to `github.workspace` during the main step and removes it automatically in the post step.
17-
18-
## Usage
19-
20-
```yaml
21-
- uses: ./../local-actions
22-
with:
23-
source-path: ${{ github.action_path }}/../..
24-
25-
- uses: ./../self-actions/get-issue-number
26-
```
27-
28-
## Inputs
29-
30-
| **Input** | **Description** | **Required** | **Default** |
31-
| ----------------- | ------------------------------------------------------------------------------ | ------------ | ----------- |
32-
| **`source-path`** | The actions root path. Pass `${{ github.action_path }}/../..` from the caller. | **true** | - |
33-
34-
## Outputs
35-
36-
| **Output** | **Description** |
37-
| ---------- | ---------------------------------------------------- |
38-
| **`path`** | The resolved destination path for the copied actions |
3912
<!-- badges:start -->
4013

4114
[![Marketplace](https://img.shields.io/badge/Marketplace-local--actions-blue?logo=github-actions)](https://github.com/marketplace/actions/local-actions)
@@ -50,17 +23,16 @@ It creates a symlink to the parent actions directory at `../self-actions` relati
5023
## Overview
5124

5225
Action to expose sibling local actions next to the current action directory.
53-
It copies the parent actions directory into a configurable destination and cleans it up automatically in the post action.
54-
55-
FIXME: This is a workaround until this issue is resolved: <https://github.com/actions/runner/issues/1348>.
26+
It creates a symlink to the parent actions directory at `../self-actions` relative to `github.workspace`
27+
during the main step and removes it automatically in the post step.
5628

5729
<!-- overview:end -->
5830
<!-- usage:start -->
5931

6032
## Usage
6133

6234
```yaml
63-
- uses: hoverkraft-tech/ci-github-common/actions/local-actions@4b53189212d5810f710bed89711002626977215b # 0.33.0
35+
- uses: hoverkraft-tech/ci-github-common/actions/local-actions@03a5a2a3626b03434b19b79cdd2e141bea410bae # main
6436
with:
6537
# The actions root path that contains the sibling local actions.
6638
# Pass the caller actions root, typically by appending `/../..` to `github.action_path`.

actions/local-actions/action.yml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
1-
# FIXME: This is a workaround until this issue is resolved: https://github.com/actions/runner/issues/1348.
21
name: "Local actions"
32
description: |
43
Action to expose sibling local actions next to the current action directory.
5-
It copies the parent actions directory into a configurable destination and cleans it up automatically in the post action.
4+
It creates a symlink to the parent actions directory at `../self-actions` relative to `github.workspace`
5+
during the main step and removes it automatically in the post step.
6+
# FIXME: This is a workaround until this issue is resolved: https://github.com/actions/runner/issues/1348.
67
author: hoverkraft
78
branding:
89
icon: copy

0 commit comments

Comments
 (0)