https://github.com/octoherd/octoherd

Manage multiple repository updates all at once.
https://github.com/octoherd/octoherd

Last synced: 9 days ago
JSON representation

Manage multiple repository updates all at once.

• Host: GitHub
• URL: https://github.com/octoherd/octoherd
• Owner: octoherd
• License: isc
• Created: 2020-12-16T20:26:33.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2023-12-15T05:11:43.000Z (11 months ago)
• Last Synced: 2024-08-01T13:28:58.379Z (3 months ago)
• Homepage: https://twitter.com/octoherd
• Size: 62.5 KB
• Stars: 136
• Watchers: 7
• Forks: 4
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# Octoherd



Octoherd allows you to run a script against multiple repositories in parallel.

A script is a JavaScript function that receives

1. A pre-authenticated [`octokit`](https://github.com/octoherd/octokit/#readme) instance

2. A repository object

3. An options object with script-specific options

## Example

Source code for [the hello world Octoherd script](https://github.com/octoherd/script-hello-world/#readme)

```js

/**

 * The "Hello, World!" of all Octoherd Scripts!

 *

 * @param {import('@octoherd/cli').Octokit} octokit

 * @param {import('@octoherd/cli').Repository} repository

 * @param {object} options

 * @param {string} [options.greetingName] name to be greeted

 */

export async function script(octokit, repository, { greetingName = "World" }) {

  octokit.log.info("Hello, %s! From %s", greetingName, repository.full_name);

}

```

Run the hello world script with

```

npx @octoherd/script-hello-world \

  --octoherd-token 0123456789012345678901234567890123456789 \

  "octoherd/*"

```

## Find a script

For existing scripts, check out [repositories with the `octoherd-script` label](https://github.com/topics/octoherd-script).

## Create a script

To create your own script, run

```

npm init octoherd-script

```

and follow the instructions. See [octoherd/create-octoherd-script](https://github.com/octoherd/create-octoherd-script) for more information.

## Get involved

It's a great time to get involved, look out for ["pull request welcome" issues](https://github.com/issues?q=is%3Aopen+org%3Aoctoherd+label%3A%22pull+request+welcome%22).

## License

[ISC](LICENSE.md)