Skip to content

Commit

Permalink
Releasing support for branches with slashes in 4.1.0.
Browse files Browse the repository at this point in the history
  • Loading branch information
metcalfc committed Mar 13, 2023
1 parent 6745040 commit afdcb94
Show file tree
Hide file tree
Showing 6 changed files with 377 additions and 878 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ on:
push:
# Sequence of patterns matched against refs/tags
tags:
- 'v*' # Push events to matching v*, i.e. v1.0, v4.0.1
- 'v*' # Push events to matching v*, i.e. v1.0, v4.1.0

jobs:
release:
Expand All @@ -14,7 +14,7 @@ jobs:
uses: actions/checkout@v3
- name: Generate changelog
id: changelog
uses: metcalfc/changelog-generator@v4.0.1
uses: metcalfc/changelog-generator@v4.1.0
with:
myToken: ${{ secrets.GITHUB_TOKEN }}
- name: Create Release
Expand Down
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ This Action returns a markdown formatted changelog between two git references. T

I just wanted a simple way to populate the body of a GitHub Release.

<a href="https://github.com/metcalfc/changelog-generator/releases/tag/v4.0.1"><img alt="Example Release Notes" src="./release-notes.png" width="400"></a>
<a href="https://github.com/metcalfc/changelog-generator/releases/tag/v4.1.0"><img alt="Example Release Notes" src="./release-notes.png" width="400"></a>

## Inputs

Expand Down Expand Up @@ -49,7 +49,7 @@ First you will need to generate the changelog itself. To get the changelog betwe
```yaml
- name: Generate changelog
id: changelog
uses: metcalfc/changelog-generator@v4.0.1
uses: metcalfc/changelog-generator@v4.1.0
with:
myToken: ${{ secrets.GITHUB_TOKEN }}
```
Expand All @@ -59,7 +59,7 @@ Or, if you have two specific references you want:
```yaml
- name: Generate changelog
id: changelog
uses: metcalfc/changelog-generator@v4.0.1
uses: metcalfc/changelog-generator@v4.1.0
with:
myToken: ${{ secrets.GITHUB_TOKEN }}
head-ref: 'v0.0.2'
Expand All @@ -77,11 +77,11 @@ If you want to point to a branch containing forward slashes (https://github.com/

- name: Generate changelog
id: changelog
uses: metcalfc/changelog-generator@v4.0.1 #TODO: bump this after release
uses: metcalfc/changelog-generator@v4.1.0 #TODO: bump this after release
with:
myToken: ${{ secrets.GITHUB_TOKEN }}
head-ref: 'origin/my/branch/with/slashes' #add 'origin/` in front of your branch name
base-ref: 'v1.0.0'
base-ref: 'v4.1.0'
fetch: false
```
Expand Down
4 changes: 2 additions & 2 deletions SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@

| Version | Supported |
| ------- | ------------------ |
| v4.0.1 | :white_check_mark: |
| < v4.0.1 | :x: |
| v4.1.0 | :white_check_mark: |
| < v4.1.0 | :x: |

## Reporting a Vulnerability

Expand Down
Loading

0 comments on commit afdcb94

Please sign in to comment.