chore(changelog): udpate changelog and add corresponding makefile command (#53)

* chore(changelog): udpate changelog and add corresponding makefile command

* try adding that to the CI

* committing the generated changelog to the repo

---------

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
This commit is contained in:
Alexandre Pasmantier 2024-11-21 00:05:41 +01:00 committed by GitHub
parent 565283babb
commit 6540094cc9
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
4 changed files with 64 additions and 2 deletions

43
.github/workflows/changelog.yml vendored Normal file
View File

@ -0,0 +1,43 @@
name: changelog
on:
push:
branches:
- main
pull_request:
jobs:
changelog:
name: Generate changelog
runs-on: ubuntu-latest
permissions:
contents: write
steps:
- name: Checkout
uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Generate changelog
uses: orhun/git-cliff-action@v4
with:
config: cliff.toml
args: --verbose
env:
OUTPUT: CHANGELOG.md
GITHUB_REPO: ${{ github.repository }}
- name: Extract branch name
shell: bash
run: echo "branch=${GITHUB_HEAD_REF:-${GITHUB_REF#refs/heads/}}" >> $GITHUB_OUTPUT
id: extract_branch
- name: Commit
run: |
git checkout ${{ steps.extract_branch.outputs.branch }}
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 "Update changelog"
git push https://${{ secrets.GITHUB_TOKEN }}@github.com/${GITHUB_REPOSITORY}.git ${{ steps.extract_branch.outputs.branch }}

View File

@ -7,11 +7,14 @@ All notable changes to this project will be documented in this file.
### 📚 Documentation ### 📚 Documentation
- Add instructions for installing on Arch Linux (#43) - Add instructions for installing on Arch Linux (#43)
- *(brew)* Add brew installation method for MacOS to README - *(brew)* Add brew installation method for MacOS to README (#45)
- *(config)* Update docs to mention XDG_CONFIG_HOME precedence on all platform (#48)
### ⚙️ Miscellaneous Tasks ### ⚙️ Miscellaneous Tasks
- Add CHANGELOG.md (#44) - Add CHANGELOG.md (#44)
- *(config)* Default configuration now uses 100% of terminal screen space (#47)
- *(changelog)* Udpate changelog and add corresponding makefile command
## [0.5.0] - 2024-11-18 ## [0.5.0] - 2024-11-18
@ -132,6 +135,9 @@ All notable changes to this project will be documented in this file.
### 🐛 Bug Fixes ### 🐛 Bug Fixes
- Fixing various issues
- Fixing various issues
- Fix linting issues and ignore derive docs for tests
- Filtering system directories in gitrepos - Filtering system directories in gitrepos
- Stabilize preview scroll initialization - Stabilize preview scroll initialization
- Doctests imports - Doctests imports
@ -139,17 +145,26 @@ All notable changes to this project will be documented in this file.
### 🚜 Refactor ### 🚜 Refactor
- Refactoring
- Refactoring matcher
- Extract matcher logic into separate crate - Extract matcher logic into separate crate
- Split project into separate crates - Split project into separate crates
- More refactoring and fixing doctests - More refactoring and fixing doctests
### 📚 Documentation ### 📚 Documentation
- Docs and linting
- Documentation
- Update README.md - Update README.md
- Add default keybindings to README.md - Add default keybindings to README.md
- Some work on CONTRIBUTING.md - Some work on CONTRIBUTING.md
- More work on CONTRIBUTING.md - More work on CONTRIBUTING.md
### 🧪 Testing
- Tests and docs for strings.rs
- Testing ci
### ⚙️ Miscellaneous Tasks ### ⚙️ Miscellaneous Tasks
- Bump version - Bump version

View File

@ -54,3 +54,7 @@ bump-workspace:
publish: publish:
@echo "Publishing $(NAME)" @echo "Publishing $(NAME)"
@./scripts/publish.sh @./scripts/publish.sh
update-changelog:
@echo "Updating changelog"
@git cliff -o CHANGELOG.md

View File

@ -47,7 +47,7 @@ postprocessors = [
# parse the commits based on https://www.conventionalcommits.org # parse the commits based on https://www.conventionalcommits.org
conventional_commits = true conventional_commits = true
# filter out the commits that are not conventional # filter out the commits that are not conventional
filter_unconventional = true filter_unconventional = false
# process each line of a commit as an individual commit # process each line of a commit as an individual commit
split_commits = false split_commits = false
# regex for preprocessing the commit messages # regex for preprocessing the commit messages