From 6540094cc9977419a92c4dcf37d761bebd5f052a Mon Sep 17 00:00:00 2001 From: Alexandre Pasmantier <47638216+alexpasmantier@users.noreply.github.com> Date: Thu, 21 Nov 2024 00:05:41 +0100 Subject: [PATCH] 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/workflows/changelog.yml | 43 +++++++++++++++++++++++++++++++++ CHANGELOG.md | 17 ++++++++++++- Makefile | 4 +++ cliff.toml | 2 +- 4 files changed, 64 insertions(+), 2 deletions(-) create mode 100644 .github/workflows/changelog.yml diff --git a/.github/workflows/changelog.yml b/.github/workflows/changelog.yml new file mode 100644 index 0000000..df015a0 --- /dev/null +++ b/.github/workflows/changelog.yml @@ -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 }} diff --git a/CHANGELOG.md b/CHANGELOG.md index 9d29fb2..c8622a3 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,11 +7,14 @@ All notable changes to this project will be documented in this file. ### ๐Ÿ“š Documentation - 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 - 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 @@ -132,6 +135,9 @@ All notable changes to this project will be documented in this file. ### ๐Ÿ› Bug Fixes +- Fixing various issues +- Fixing various issues +- Fix linting issues and ignore derive docs for tests - Filtering system directories in gitrepos - Stabilize preview scroll initialization - Doctests imports @@ -139,17 +145,26 @@ All notable changes to this project will be documented in this file. ### ๐Ÿšœ Refactor +- Refactoring +- Refactoring matcher - Extract matcher logic into separate crate - Split project into separate crates - More refactoring and fixing doctests ### ๐Ÿ“š Documentation +- Docs and linting +- Documentation - Update README.md - Add default keybindings to README.md - Some work on CONTRIBUTING.md - More work on CONTRIBUTING.md +### ๐Ÿงช Testing + +- Tests and docs for strings.rs +- Testing ci + ### โš™๏ธ Miscellaneous Tasks - Bump version diff --git a/Makefile b/Makefile index bb58829..4c21ebb 100644 --- a/Makefile +++ b/Makefile @@ -54,3 +54,7 @@ bump-workspace: publish: @echo "Publishing $(NAME)" @./scripts/publish.sh + +update-changelog: + @echo "Updating changelog" + @git cliff -o CHANGELOG.md diff --git a/cliff.toml b/cliff.toml index 3d56204..9e8e631 100644 --- a/cliff.toml +++ b/cliff.toml @@ -47,7 +47,7 @@ postprocessors = [ # parse the commits based on https://www.conventionalcommits.org conventional_commits = true # filter out the commits that are not conventional -filter_unconventional = true +filter_unconventional = false # process each line of a commit as an individual commit split_commits = false # regex for preprocessing the commit messages