Skip to content

Commit

Permalink
Update readme (#27)
Browse files Browse the repository at this point in the history
* prettify start of readme

* describe alternatives
  • Loading branch information
CramBL authored Jan 1, 2025
1 parent 0bb246e commit c6bea4a
Showing 1 changed file with 33 additions and 7 deletions.
40 changes: 33 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,27 @@
[![CI](https://github.com/CramBL/dependabot-changelog-writer/actions/workflows/CI.yml/badge.svg)](https://github.com/CramBL/dependabot-changelog-writer/actions/workflows/CI.yml)
[![codecov](https://codecov.io/github/CramBL/dependabot-changelog-writer/graph/badge.svg?token=YBFSKWY0HI)](https://codecov.io/github/CramBL/dependabot-changelog-writer)
![GitHub Downloads (all assets, all releases)](https://img.shields.io/github/downloads/CramBL/dependabot-changelog-writer/total)
<div align=right>Table of Contents↗️</div>

# dependabot-changelog-writer
<h1 align=center><code>Dependabot Changelog Writer</code></h1>

**Generate a changelog entry** from a dependabot PR, **commit** & **push** the changes.
<div align=center>
<a href=https://github.com/CramBL/dependabot-changelog-writer/actions>
<img src=https://github.com/CramBL/dependabot-changelog-writer/actions/workflows/CI.yml/badge.svg alt="CI status">
</a>
<a href=https://codecov.io/github/CramBL/dependabot-changelog-writer>
<img src=https://codecov.io/github/CramBL/dependabot-changelog-writer/graph/badge.svg?token=YBFSKWY0HI alt=codecov>
</a><a href=https://github.com/CramBL/dependabot-changelog-writer/releases>
<img src=https://img.shields.io/github/downloads/CramBL/dependabot-changelog-writer/total alt="GitHub Downloads (all assets, all releases)">
</a>

## Minimal workflow example
<br>
<br>

<b>Generate a changelog entry</b> from a dependabot PR, <b>commit</b> & <b>push</b> the changes.

</div>

## Using this action
<br>

## Minimal workflow example

If your project has a `CHANGELOG.md` at the project root that always contains an `unreleased` section where you want Dependabot updates to be written under `### Dependencies`:

Expand Down Expand Up @@ -122,3 +135,16 @@ Then commits and pushes the changes to the current branch.
- [x] A submodule was updated to another **short SHA**
- [x] The `Dependencies` section already contains an entry like `bump X from A to B` - Handled by replacing that entry with `bump X from A to C`
- [x] Branch is checked out detached from HEAD (e.g. workflow triggered by opened pull request) - Locates HEAD from remote before committing

## Alternatives

An alternative to this action is to combine a solution to generate changelog entries with a solution to add, commit, & push changes. If you have or know of a solution and it is not listed here, please make an issue so I can add it.

### Generating dependabot changelog entries:

- [dangoslen/dependabot-changelog-helper](https://github.com/dangoslen/dependabot-changelog-helper)

### Adding, committing, & pushing changes

- [EndBug/add-and-commit](https://github.com/EndBug/add-and-commit/)
- [stefanzweifel/git-auto-commit-action](https://github.com/stefanzweifel/git-auto-commit-action)

0 comments on commit c6bea4a

Please sign in to comment.