Skip to content

Rewrite README prose in plain technical style #31

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
neilvcarvalho merged 1 commit into from
Aug 28, 2026
Merged

Rewrite README prose in plain technical style #31

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
22 changes: 11 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ according to a configurable grouping strategy, and reconciles its own PRs
across runs (force-pushing when versions move, closing when packages are
no longer outdated).

Dependabot does not support importmap-rails natively. Neither does Renovate.
This action fills that gap.
Neither Dependabot nor Renovate supports importmap-rails natively, so this
action covers that case.

## Quick start

Expand Down Expand Up @@ -48,9 +48,9 @@ jobs:
github-token: ${{ secrets.GITHUB_TOKEN }}
```

That's enough to get going with the baked-in defaults. For first-time use,
set `dry-run: "true"` so you can review the action's log and see exactly
what it _would_ do before flipping the switch.
The defaults are sufficient for most projects. For first-time use, set
`dry-run: "true"` and review the action's log to confirm what the action
will do.

## Configuration

Expand All @@ -74,8 +74,8 @@ branch_prefix: "importmap-updates"

All fields are optional. Missing fields fall back to defaults. Both
underscore and dash key styles are accepted (so
`open-pull-requests-limit` works too — convenient if you're coming from
Dependabot's config).
`open-pull-requests-limit` works too, which is convenient if you're
coming from Dependabot's config).

### Grouping strategies

Expand All @@ -85,8 +85,8 @@ per package).

Security always takes priority over the semver bucket: a vulnerable
package that happens to be a major bump becomes a **security** PR, not a
major PR — but the PR body and metadata still record that it's a major
bump so reviewers know to expect breaking changes.
major PR. The PR body and metadata still record that it's a major bump,
so reviewers know to expect breaking changes.

### Open-PR budget

Expand All @@ -98,9 +98,9 @@ PRs are kept in priority order major → minor → patch.

- **Foreign PRs are never touched.** A PR on a branch matching the
configured prefix but without the action's metadata block is left
alone — never closed, edited, or force-pushed. A human who manually
alone: never closed, edited, or force-pushed. A human who manually
creates a PR on the `importmap-updates/*` namespace will not have
their work clobbered.
their work overwritten.
- **Dry-run mode.** Set `dry-run: "true"` to run end-to-end without
side effects. Every action is reported in the workflow log.
- **Branch ownership via embedded metadata.** Every PR the action opens
Expand Down