Skip to content
This repository has been archived by the owner on Mar 25, 2024. It is now read-only.

cerebruminc/private-action-loader

 
 

Repository files navigation

Private Action Loader

Actions Status License: MIT JavaScript Style Guide Dependency Status devDependency Status Code Coverage

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


Inputs

pal-repo-token

Required An access token with the repo scope to the repository containing the action. This should be stored as a repo secret.

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

- 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

- 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

- 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

- 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

- 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

- 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

- 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.<name of output> }}"

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@<whatever> will still work, but will just pull from nick-fields/private-action-loader@<whatever> 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.

About

Allows private GitHub Actions to be easily reused

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 53.7%
  • JavaScript 45.5%
  • Shell 0.8%