Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/julia-actions/massinstallaction.jl
Quickly and easily install a GitHub Action on all repositories in a GitHub organization
https://github.com/julia-actions/massinstallaction.jl
Last synced: 4 days ago
JSON representation
Quickly and easily install a GitHub Action on all repositories in a GitHub organization
- Host: GitHub
- URL: https://github.com/julia-actions/massinstallaction.jl
- Owner: julia-actions
- License: mit
- Created: 2020-01-14T10:34:46.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2023-12-11T22:47:03.000Z (about 1 year ago)
- Last Synced: 2025-01-02T19:57:47.460Z (6 days ago)
- Language: Julia
- Size: 47.9 KB
- Stars: 31
- Watchers: 7
- Forks: 6
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# MassInstallAction
[](https://github.com/julia-actions/MassInstallAction.jl/actions?query=workflow%3ACI)
[](https://codecov.io/gh/julia-actions/MassInstallAction.jl)
Install a [GitHub Action](https://docs.github.com/en/free-pro-team@latest/actions) [workflow file](https://docs.github.com/en/free-pro-team@latest/actions/reference/workflow-syntax-for-github-actions) in one or more repositories.
There are two key steps: (1) creating the `workflow` and (2) installing it, a.k.a,
submitting it as pull request(s) to one or more packages.
## Creating the workflow
Some workflows have convenient helpers:
```julia
julia> workflow = MassInstallAction.compat_helper() # workflow for https://github.com/JuliaRegistries/CompatHelper.jl
julia> workflow = MassInstallAction.tag_bot() # workflow for https://github.com/JuliaRegistries/TagBot
```
or you can create your own:
```julia
workflow = MassInstallAction.Workflow("MyWorkflow", "workflow_filename.yml" => read("/home/me/template_workflow_file.yml", String))
```
where you replace:
- `"/home/me/template_workflow_file.yml"` with the path to the local file you've prepared with the desired contents of the workflow;
- `"workflow_filename.yml"` with the name you want the file to have in the repositories' `.github/workflows` directory;
- `"MyWorkflow"` with the name used to identify this workflow when Actions runs.
You can add multiple workflow files simultaneously or even delete files, see `?MassInstallAction.Workflow`.
## Installing the workflow: examples
### Install a workflow on all repositories in your GitHub organization
First make sure that you have an environment variable
named `MY_GITHUB_TOKEN` that contains a GitHub personal
access token (see below), and then run the following code.
Replace
`MY_ORGANIZATION` with the name of your GitHub
organization.
Replace `MY_USERNAME`, `ANOTHER_ORG_ADMIN`, etc. with your username and the
usernames of other administrators in your GitHub
organization.
```julia
julia> using MassInstallAction
julia> workflow = MassInstallAction.compat_helper()
julia> MassInstallAction.install(workflow,
"MY_ORGANIZATION";
token = ENV["MY_GITHUB_TOKEN"],
cc = ["MY_USERNAME", "ANOTHER_ORG_ADMIN"])
```
### Install a workflow on all repositories in your personal GitHub account
First make sure that you have an environment variable
named `MY_GITHUB_TOKEN` that contains a GitHub personal
access token, and then run the following code.
Replace `MY_USERNAME` with your GitHub username.
```julia
julia> using MassInstallAction
julia> workflow = MassInstallAction.compat_helper()
julia> MassInstallAction.install(workflow,
"MY_USERNAME";
token = ENV["MY_GITHUB_TOKEN"],
cc = ["MY_USERNAME"])
```
### Interaction with GitHub.jl
This package uses and interacts with [GitHub.jl](https://github.com/JuliaWeb/GitHub.jl). In addition to the options above, you can `MassInstallAction.install(workflow, repo::GitHub.Repo)` directly. This may be the easiest approach if you want to filter repositories based on specific criteria. See `?MassInstallAction.install` for more information.
### Generating GitHub personal access token
To generate the GitHub personal access token, follow the instructions from [this official link](https://docs.github.com/en/free-pro-team@latest/github/authenticating-to-github/creating-a-personal-access-token).
You should give these access in your GitHub token:
- repo access:
- workflow access:
