Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nick-fields/private-action-loader
Allows private GitHub Actions to be easily reused
https://github.com/nick-fields/private-action-loader
Last synced: about 2 months ago
JSON representation
Allows private GitHub Actions to be easily reused
- Host: GitHub
- URL: https://github.com/nick-fields/private-action-loader
- Owner: nick-fields
- License: mit
- Created: 2019-11-20T18:41:59.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-02-15T16:41:23.000Z (7 months ago)
- Last Synced: 2024-05-22T23:42:54.179Z (4 months ago)
- Language: TypeScript
- Size: 2.3 MB
- Stars: 168
- Watchers: 87
- Forks: 38
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Private Action Loader
[](https://github.com/nick-fields/private-action-loader/actions)
[](https://opensource.org/licenses/MIT)
[](https://standardjs.com)
[](https://david-dm.org/nick-fields/private-action-loader)
[](https://david-dm.org/nick-fields/private-action-loader#info=devDependencies)
[](https://codecov.io/gh/nick-fields/private-action-loader)
This action loads and executes a private Action. This allows private actions to be reused in other private repositories. All inputs are passed down into the private action. All outputs of the private actions are passed back to the loader action.
**NOTE:** Ownership of this project was transferred to my personal account `nick-fields` from `invisionapp` then `nick-invision`. Details [here](#Ownership)
---
## **Inputs**
### **`pal-repo-token`**
**Required** An access token with the [repo](https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line) scope to the repository containing the action. **This should be stored as a [repo secret](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets)**.
### **`pal-repo-name`**
**Required** The repository containing the action. A ref can also be appended to specify an exact commit of the action (SHA, tag, or branch). Must be in the format of `{owner}/{repo}` or `{owner}/{repo}@{sha}`.
### **`pal-action-directory`**
**Optional** Directory containing the `action.yml` that you would like to execute in repo. If omitted, the root directory is assumed to be the location of `action.yml`.
---
## **Examples**
## Example usage w/ pal-action-directory
```yaml
- uses: nick-fields/private-action-loader@v3
with:
pal-repo-token: ${{ secrets.REPO_TOKEN }}
pal-repo-name: some-org/super-secret-action
pal-action-directory: src/super-secret-nested-action
```
## Example usage w/ additional parameters
```yaml
- uses: nick-fields/private-action-loader@v3
with:
pal-repo-token: ${{ secrets.REPO_TOKEN }}
pal-repo-name: some-org/super-secret-action
# the following input gets passed to the private action
input-used-by-other-action: this will be passed to super-secret-action
```
## Example usage w/o additional parameters
```yaml
- uses: nick-fields/private-action-loader@v3
with:
pal-repo-token: ${{ secrets.REPO_TOKEN }}
pal-repo-name: some-org/super-secret-action
```
## Example usage w/ SHA
```yaml
- uses: nick-fields/private-action-loader@v3
with:
pal-repo-token: ${{ secrets.REPO_TOKEN }}
pal-repo-name: some-org/super-secret-action@b8a83a0
```
## Example usage w/ Branch
```yaml
- uses: nick-fields/private-action-loader@v3
with:
pal-repo-token: ${{ secrets.REPO_TOKEN }}
pal-repo-name: some-org/super-secret-action@master
```
## Example usage w/ Tag
```yaml
- uses: nick-fields/private-action-loader@v3
with:
pal-repo-token: ${{ secrets.REPO_TOKEN }}
pal-repo-name: some-org/super-secret-action@v1
```
## Example usage w/ Output
```yaml
- uses: nick-fields/private-action-loader@v3
id: output_example
with:
pal-repo-token: ${{ secrets.REPO_TOKEN }}
pal-repo-name: some-org/super-secret-action@v1
- name: Get the previous output
run: echo "The previous output was ${{ steps.output_example.outputs. }}"
```
---
## **Limitations**
- Only supports javascript actions
## **Ownership**
As of 2022/02/15 ownership of this project has been transferred to my personal `nick-fields` account due to me leaving InVision. Previously on 2021/04/28 ownership of this project was transferred from the `InVisionApp` organization to my work account `nick-invision` due to changes to our organization level security settings that conflicts with public GitHub Actions. I am the author and have been the primary maintainer since day one and will continue to maintain this as needed.
No immediate action is required if you rely on this as GitHub handles ownership transfers pretty well. Any current workflow reference to `nick-invision/private-action-loader@` will still work, but will just pull from `nick-fields/private-action-loader@` instead. Who knows how long that will work, so at some point it would be beneficial to update your workflows to reflect the new owner accordingly.