https://github.com/wei18/local-composite-action
A GitHub Action that resolves local composite action paths and automatically creates symlinks to reference them easily.
https://github.com/wei18/local-composite-action
composite-action github-action
Last synced: 4 months ago
JSON representation
A GitHub Action that resolves local composite action paths and automatically creates symlinks to reference them easily.
- Host: GitHub
- URL: https://github.com/wei18/local-composite-action
- Owner: wei18
- License: mit
- Created: 2025-04-11T12:46:03.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2025-05-02T06:49:02.000Z (5 months ago)
- Last Synced: 2025-06-05T10:11:46.420Z (4 months ago)
- Topics: composite-action, github-action
- Homepage:
- Size: 32.2 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 📦 local-composite-action
A GitHub Action to conveniently reference local actions!
## ✨ Features
- ✅ Automatically resolves the local composite action path
- ✅ Creates symlinks to use `./../org/repo/path/to/action` references
- ✅ Compatible with default GitHub Actions behavior---
## 🔧 Usage
```yaml
name: Your composite actionruns:
using: 'composite'
steps:
- uses: wei18/local-composite-action@v1
with:
action_repository: ${{ github.action_repository }}
- name: Run local your composite action
uses: ./../org/repo/.github/composite-actions/example/just-composite-action- name: Run local your second composite action
uses: ./../org/repo/.github/composite-actions/example/another-composite-action
```> [!IMPORTANT]
> Adjust the relative path based on the symlink location (typically one level above `$GITHUB_WORKSPACE`).
>
> This version emphasizes that `./../` is required and clarifies why it needs to be used.---
## 📥 Inputs
| Name | Description | Required | Default |
|---------------------|-----------------------------------------------|----------|---------------------------|
| `action_path` | The actual path to the composite action | | ${{ github.action_path }} |
| `action_repository` | The repository name in the form of `org/repo` | ✅ | |---
## 💡 Why this?
In GitHub Actions, the `composite` action supports `uses: ./local-path`, but when dealing with monorepos or complex path references, symlinks may not exist, causing failures. This tool helps automatically create the required symlinks, making the references work seamlessly!
---
## 📄 License
MIT © [wei18](https://github.com/wei18)