Skip to content

Commit

Permalink
N/A: added not applicable change log into the version history
Browse files Browse the repository at this point in the history
This will be used for non versionable changes, like documentation, repo management changes... etc
  • Loading branch information
Supermanuu committed Aug 9, 2024
1 parent b18b713 commit 4bc8817
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 9 deletions.
1 change: 0 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
# Sofle Battery Switcher

[![CI pipeline list](https://github.com/Supermanuu/BatterySwitcher/actions/workflows/release.yml/badge.svg?branch=main)](https://github.com/Supermanuu/BatterySwitcher/actions/workflows/release.yml)

[![link to latest version](https://img.shields.io/badge/version-latest-blue)](https://github.com/Supermanuu/BatterySwitcher/releases/latest)

We are triying yo make a battery switch for the Sofle Keyboard, or properly said, the [nRFMicro](https://github.com/joric/nrfmicro/tree/1.4) board used by the [Sofle](https://github.com/josefadamcik/SofleKeyboard) Keyboard.
Expand Down
8 changes: 5 additions & 3 deletions doc/user-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,14 @@ In this files you will have a lot of information for building this project:
* [iBOM](ibom.html)
* [Schematic (only works from artifact documentation)](schematic.pdf)

Buy all the components whatever you like and then, start building:
Buy all the components in the [iBOM](ibom.html) and the ones gathered in [Out of BOM](out-of-bom.md) from whatever supplier you like and then, start building:

1. [PCB](mounting/pcb.md)
2. [Battery connector (optional)](mounting/battery-connector.md)
3. [Bendig](mounting/bending.md)

[Github repo](https://github.com/Supermanuu/BatterySwitcher)
---

[Latest release](https://github.com/Supermanuu/BatterySwitcher/releases)
[![GitHub repo link](https://img.shields.io/badge/GitHub-100000?logo=github)](https://github.com/Supermanuu/BatterySwitcher)
[![CI pipeline list](https://github.com/Supermanuu/BatterySwitcher/actions/workflows/release.yml/badge.svg?branch=main)](https://github.com/Supermanuu/BatterySwitcher/actions/workflows/release.yml)
[![Link to latest version](https://img.shields.io/badge/latest-version-blue)](https://github.com/Supermanuu/BatterySwitcher/releases/latest)
11 changes: 6 additions & 5 deletions scripts/hooks/commit-msg.sh
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,10 @@ COMMIT_MSG_FILE=$1
COMMIT_MSG=$(cat $COMMIT_MSG_FILE)

# Define the required patterns
PATCH_PATTERN="fix\(.*\)"
MINOR_PATTERN="feat\(.*\)"
MAJOR_PATTERN="perf\(.*\)"
PATCH_PATTERN="fix\(.*\): "
MINOR_PATTERN="feat\(.*\): "
MAJOR_PATTERN="perf\(.*\): "
NA_PATTERN="N/A: "

function is_interactive {
if [[ $- =~ *i* ]]; then
Expand All @@ -18,11 +19,11 @@ function is_interactive {
}

# Check if the commit message contains any of the required patterns
if echo "$COMMIT_MSG" | grep -qE "$PATCH_PATTERN|$MINOR_PATTERN|$MAJOR_PATTERN"; then
if echo "$COMMIT_MSG" | grep -qE "$NA_PATTERN|$PATCH_PATTERN|$MINOR_PATTERN|$MAJOR_PATTERN"; then
exit 0
fi

echo "Warning: Commit message does not contain 'fix(*)', 'feat(*)', or 'perf(*)'."
echo "Warning: Commit message does not contain 'N/A: ' , 'fix(*): ', 'feat(*): ', or 'perf(*): '."
echo "Please ensure your commit message includes one of these patterns."
echo "See also https://github.com/mathieudutour/github-tag-action?tab=readme-ov-file#bumping"

Expand Down

0 comments on commit 4bc8817

Please sign in to comment.