Skip to content

Commit c78865c

Browse files
committed
Add README and CHANGELOG
1 parent f418308 commit c78865c

File tree

2 files changed

+41
-0
lines changed

2 files changed

+41
-0
lines changed

CHANGELOG.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
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.0.0/),
6+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7+
8+
## [Unreleased]
9+
10+
Nothing yet.
11+
12+
## [0.1.0] - 2020-09-05
13+
14+
The first release! Includes the `sync` command which will sync your `CHANGELOG.md` to GitHub Release notes.
15+
16+
[Unreleased]: https://github.com/dropseed/sitechecks/compare/0.1.0...HEAD
17+
[0.1.0]: https://github.com/dropseed/sitechecks/releases/tag/0.1.0

README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# changerelease
2+
3+
Sync your GitHub Release notes with your `CHANGELOG.md`.
4+
5+
This tool expects that you follow the [Keep a Changelog](https://keepachangelog.com/) format.
6+
7+
## Use the GitHub Action
8+
9+
```yml
10+
name: changerelease
11+
on:
12+
workflow_dispatch: {}
13+
push:
14+
paths: [CHANGELOG.md]
15+
branches: [$default-branch]
16+
tags: ["*"]
17+
18+
jobs:
19+
sync:
20+
runs-on: ubuntu-latest
21+
steps:
22+
- uses: actions/checkout@v2
23+
- uses: dropseed/changerelease
24+
```

0 commit comments

Comments
 (0)