Skip to content
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.

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

Prep release v3.8.0 #244

Merged
merged 9 commits into from
Feb 2, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
8 changes: 5 additions & 3 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,14 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)

## [UNRELEASED]

## [3.8.0]

### Added
- Adds scaffolding for `EntryExtractor`` to support different tools (Dependabot, Mend Renovate, etc).
- Adds a new `activationLabels` input to allow for more complex workflows. See [#233](https://github.com/dangoslen/dependabot-changelog-helper/issues/233) for more details as to why. This input will be removed in the next major release, which currently has a TBD release date.
- Adds scaffolding for `EntryExtractor` to support different tools (Dependabot, Mend Renovate, etc) in the future. See [#288](https://github.com/dangoslen/dependabot-changelog-helper/issues/228) for more details.
- Adds a new `activationLabels` input to allow for more complex workflows. See [#233](https://github.com/dangoslen/dependabot-changelog-helper/issues/233) for more details as to why.

### Deprecated
- The `activationLabel` is now deprecated in favor of the `activationLabels` (see the `Added` section above). This input will be removed in the next major release, which currently has a TBD release date.
- The `activationLabel` input is now deprecated in favor of the `activationLabels` inpput (see the `Added` section above). The `activationLabel` input will be removed in the next major release, which currently has a TBD release date.

### Dependencies
- Bump `eslint-plugin-jest` from 27.6.0 to 27.6.3 ([#236](https://github.com/dangoslen/dependabot-changelog-helper/pull/236))
Expand Down
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,6 @@ jobs:
- uses: dangoslen/dependabot-changelog-helper@v3
with:
version: ${{ needs.setup.outputs.version }}
activationLabel: 'dependabot'
changelogPath: './CHANGELOG.md'

# This step is required for committing the changes to your branch.
Expand Down Expand Up @@ -96,15 +95,17 @@ This is a way to incrementally build a version over time and only release a vers

| Default | Description |
| -------- | ------------------------------------------------------------------------------------------------------------ |
| `''` | DEPRECATED! Please use the `acticationLabels` input below. The label to indicate that the action should run. |
| `dependabot` | DEPRECATED! Please use the `acticationLabels` input below. The label to indicate that the action should run. |

If both `activationLabel` and `activationLabels` inputs are provided, _all_ labels between the two inputs are required for the action to run.

#### `activationLabels`

| Default | Description |
| ------------ | ------------------------------------------------- |
| `dependabot` | The label to indicate that the action should run. |
| `` | The labels to indicate that the action should run. All of the labels must be present in order for the action to run. |

_Note: by default this is currently set to empty. In a future release, it will have the default of `dependabot` and replace the `activationLabel` input.

#### `entryPrefix`

Expand Down
4 changes: 2 additions & 2 deletions action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,12 @@ inputs:
description: |
"DEPRECATED! Please use `activationLabels` instead. The label to indicate that the action should run"
required: true
default: ''
default: 'dependabot'
activationLabels:
description: |
"The labels to activate/run this action. Labels are comma-separated. Each label must be present on the pull request for the action to run."
required: true
default: 'dependabot'
default: ''
entryPrefix:
description: |
"The prefix word (after the hyphen) of the changelog entry, for example: '- [entryPrefix] `dependency` from v1.0 to v2.0'"
Expand Down
2 changes: 1 addition & 1 deletion coverage/badge.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions dist/index.js

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

2 changes: 1 addition & 1 deletion dist/index.js.map

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "dependabot-helper",
"version": "3.7.0",
"version": "3.8.0",
"private": false,
"description": "A GitHub Action to auto-add dependabot changes to your changelog and increment version numbers",
"main": "lib/dependabot-helper.js",
Expand Down
6 changes: 6 additions & 0 deletions src/dependabot-helper.ts
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,12 @@ export async function run(): Promise<void> {
const sectionHeader: string = core.getInput('sectionHeader')
const payload = github.context.payload

if (label !== '' && label !== 'dependabot') {
core.warning(
'`activationLabel` is deprecated, use `activationLabels` instead'
)
}

const labels = parseLabels(labelsString)
if (label !== '' && !labels.includes(label)) {
labels.push(label)
Expand Down
Loading