Skip to content

Cleanup readme #5

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.

Sign up for GitHub

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

Merged
JaredCE merged 3 commits into from
Aug 10, 2026
Merged

Cleanup readme #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8b927fd
update README
JaredCE Aug 10, 2026
8feab86
0.0.5
JaredCE Aug 10, 2026
6be9c6f
add Badges
JaredCE Aug 10, 2026
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
23 changes: 8 additions & 15 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
[![Open on npmx.dev](https://npmx.dev/api/registry/badge/engines/dependabot-for-git)](https://npmx.dev/package/dependabot-for-git)
[![Open on npmx.dev](https://npmx.dev/api/registry/badge/version/dependabot-for-git)](https://npmx.dev/package/dependabot-for-git)
![workflow status](https://github.com/JaredCE/dependabot-for-git/actions/workflows/node.yml/badge.svg)
[![BuyMeACoffee](https://raw.githubusercontent.com/pachadotdev/buymeacoffee-badges/main/bmc-yellow.svg)](https://buymeacoffee.com/jarede)

# dependabot-for-git

Reusable CLI that runs [dependabot/cli](https://github.com/dependabot/cli) update jobs against a git
Expand All @@ -22,30 +27,18 @@ Adding a new provider means implementing the interface in `src/providers/bitbuck
and registering it in `src/providers/index.mjs` — `src/run-updates.mjs` and
`src/create-prs.mjs` don't need to change at all.

## Publishing

```bash
npm publish --access public
```

Nothing in this package is secret — all tokens are supplied at runtime via env vars,
never embedded — so publishing publicly means consuming pipelines don't need any npm auth
just to install the tool. If your org requires it private, publish with
`--access restricted` and set up an `.npmrc` in each consuming pipeline pointing at an npm
token with read access to your scope.

## Using it in a repo

### Bitbucket Cloud

Copy `templates/bitbucket-pipelines.yml` -> `bitbucket-pipelines.yml` and
`templates/dependabot-config.json` -> `dependabot-config.json`. Set the three repository
Copy [`templates/bitbucket-pipelines.yml`](templates/bitbucket-pipelines.yml) -> `bitbucket-pipelines.yml` and
[`templates/dependabot-config.json`](templates/dependabot-config.json) -> `dependabot-config.json`. Set the three repository
variables listed in the template's header comment, then trigger the `dependabot-update`
custom pipeline manually or on a schedule (Repo settings -> Pipelines -> Schedules).

### GitLab

Copy `templates/gitlab-ci.yml` -> `.gitlab-ci.yml` and `templates/dependabot-config.json`
Copy [`templates/gitlab-ci.yml`](templates/gitlab-ci.yml) -> `.gitlab-ci.yml` and [`templates/dependabot-config.json`](templates/dependabot-config.json)
-> `dependabot-config.json`. Set the CI/CD variables listed in the template's header
comment (Settings -> CI/CD -> Variables), then trigger it manually ("Run pipeline") or on
a schedule (Build -> Pipeline schedules).
Expand Down
4 changes: 2 additions & 2 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "dependabot-for-git",
"version": "0.0.4",
"version": "0.0.5",
"private": false,
"type": "module",
"description": "Runs dependabot/cli update jobs against Bitbucket Cloud or GitLab repos and turns the results into real pull/merge requests.",
Expand Down