Skip to content

Commit

Permalink
fix: remove deprecated release-notes-preview action
Browse files Browse the repository at this point in the history
This removes the deprecated `release-notes-preview` action.  It has been replaced by the
`lint-release-notes` actions with does preview as well as ensuring that breaking changes docs exist.

BREAKING CHANGE: Users should update `open-turo/actions-release/release-notes-preview@v2` to
`open-turo/actions-release/lint-release-notes@v3`.
  • Loading branch information
greenkiwi authored and tagoro9 committed Sep 15, 2023
1 parent 7f20099 commit e6ccbb9
Show file tree
Hide file tree
Showing 5 changed files with 15 additions and 176 deletions.
16 changes: 13 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,17 +13,27 @@ GitHub Actions for handling releases.

## Actions

### action: [`release-notes-preview`](./lint-release-notes)
### action: [`lint-release-notes`](./lint-release-notes)

Automatically generate release notes using semantic-release and post them as a comment in a pull request with the changes that would be included in the next version of the codebase if the pull request is merged.
Automatically generate release notes using semantic-release and post them as a comment in a pull request with the
changes that would be included in the next version of the codebase if the pull request is merged.

See usage [here](lint-release-notes/README.md#usage).

Documentation is found [here](lint-release-notes/README.md).

### action: [`semantic-release`](./semantic-release)

GitHub Action for Semantic Release

See usage [here](semantic-release/README.md#usage).

Documentation is found [here](semantic-release/README.md).

## Get Help

Each Action has a detailed README for how to use it as referenced above. Please review Issues, post new Issues against this repository as needed.
Each Action has a detailed README for how to use it as referenced above. Please review Issues, post new Issues against
this repository as needed.

## Contributions

Expand Down
2 changes: 1 addition & 1 deletion lint-release-notes/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ jobs:
lint-release-notes:
name: Lint release notes
steps:
- uses: open-turo/actions-release/lint-release-notes@v2
- uses: open-turo/actions-release/lint-release-notes@v3
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
```
Expand Down
5 changes: 0 additions & 5 deletions release-notes-preview/README.md

This file was deleted.

166 changes: 0 additions & 166 deletions release-notes-preview/action.yaml

This file was deleted.

2 changes: 1 addition & 1 deletion semantic-release/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ jobs:
steps:
- name: Checkout
uses: actions/checkout@v3
- uses: open-turo/actions-release/semantic-release@v2
- uses: open-turo/actions-release/semantic-release@v3
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
```
Expand Down

0 comments on commit e6ccbb9

Please sign in to comment.