Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add detailed instructions for plugin git repositories #2557

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions pages/plugins/writing.md
Original file line number Diff line number Diff line change
Expand Up @@ -251,6 +251,17 @@ steps:
```
{: codeblock-file="pipeline.yml"}

To use a private repository or a plugin hosted on another git host, you can use an absolute URL in the `<protocol>://<user>@<host>/<repo>` format. If you are using SSH, your build agent should have the SSH keys set up correctly for the authentication to work.

```yml
steps:
- command: ls
plugins:
- ssh://[email protected]/a-github-user/file-counter:
pattern: '*.md'
```
{: codeblock-file="pipeline.yml"}

## Publish to the Buildkite plugins directory

To add your plugin to the [Buildkite plugins directory](https://buildkite.com/plugins), publish your repository to a public GitHub repository and add the `buildkite-plugin` [repository topic tag](https://github.com/topics/buildkite-plugin). For full instructions, see the [plugins directory documentation](/docs/plugins/directory).
Expand Down