Skip to content

Commit

Permalink
feat: add .github folder and changelog GHA
Browse files Browse the repository at this point in the history
resolves #5
  • Loading branch information
jimbrig committed Mar 18, 2024
1 parent 38b585b commit 8db5d7c
Show file tree
Hide file tree
Showing 3 changed files with 58 additions and 0 deletions.
12 changes: 12 additions & 0 deletions .github/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# GitHub Folder

> [!NOTE]
> The `.github` directory contains files that are used to configure GitHub for the repository.
The `.github` directory contains the following files:

- [`dependabot.yml`](./dependabot.yml): A default `dependabot.yml` file that can be used to configure Dependabot for the repository.

## Workflows

- [`workflows/changelog.yml`](./workflows/changelog.yml): A default repository GitHub Action Workflow to automate the generation of the project's [`CHANGELOG.md`](./../CHANGELOG.md).
8 changes: 8 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# No Clocks, LLC Default `dependabot.yml` Configuration File
version: 2
updates:
# GitHub Actions
- package-ecosystem: "github-actions"
directory: ".github/workflows"
schedule:
interval: "daily"
38 changes: 38 additions & 0 deletions .github/workflows/changelog.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
name: Automate Changelog
on:
workflow_dispatch:
push:
pull_request:
branches:
- main
jobs:
changelog:
name: Generate Changelog
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
with:
fetch-depth: 0
token: ${{ secrets.GITHUB_TOKEN }}
- name: Run Git Cliff
uses: tj-actions/git-cliff@v1.5.0
id: git-cliff
with:
args: "--verbose"
output: "CHANGELOG.md"
template-config: https://raw.githubusercontent.com/noclocks/.github/main/workflow-templates/cliff.template.toml
- name: Print Changelog
id: print-changelog
run: |
cat "CHANGELOG.md"
# Commit and push the updated changelog, IF not a pull request
- name: Commit and Push Changelog
if: github.event_name != 'pull_request'
run: |
git config user.name 'github-actions[bot]'
git config user.email 'github-actions[bot]@users.noreply.github.com'
set +e
git add CHANGELOG.md
git commit -m "[chore]: update changelog"
git push https://${{ secrets.GITHUB_TOKEN }}@github.com/${GITHUB_REPOSITORY}.git "main"

0 comments on commit 8db5d7c

Please sign in to comment.