Skip to content

Commit 57a9e87

Browse files
authored
Merge pull request #386 from tempestphp/add-changelog
Adds a changelog.
2 parents 02444d6 + 6ad3cf2 commit 57a9e87

File tree

2 files changed

+26
-0
lines changed

2 files changed

+26
-0
lines changed
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
name: "Check the Changelog"
2+
on:
3+
pull_request:
4+
# The specific activity types are listed here to include "labeled" and "unlabeled"
5+
# (which are not included by default for the "pull_request" trigger).
6+
# This is needed to allow skipping enforcement of the changelog in PRs with specific labels,
7+
# as defined in the (optional) "skipLabels" property.
8+
types: [opened, synchronize, reopened, ready_for_review, labeled, unlabeled]
9+
10+
jobs:
11+
# Enforces the update of a changelog file on every pull request
12+
changelog:
13+
runs-on: ubuntu-latest
14+
steps:
15+
- uses: dangoslen/changelog-enforcer@v3
16+
with:
17+
missingUpdateErrorMessage: 'Please ensuring that you are adding your changes to the CHANGELOG.'
18+
expectedLatestVersion: ''

CHANGELOG.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
6+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7+
8+
## [Unreleased]

0 commit comments

Comments
 (0)