Merge pull request #3 from arienshibani/fix/release-workflow

Fix/release workflow

Author: arienshibani

.github/workflows/release-please.yml

@@ -0,0 +1,15 @@
+name: Release
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  release-please:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: google-github-actions/release-please-action@v4
+        with:
+          config-file: .release-please-config.json
+          skip-github-pull-request: false # Set to true if you want no PRs

.release-please-config.json

@@ -0,0 +1,6 @@
+{
+  "release-type": "simple",
+  "changelog-path": "CHANGELOG.md",
+  "include-v-in-tags": true,
+  "bump-minor-pre-major": true
+}

CHANGELOG.md

@@ -23,62 +23,80 @@ hello:
 With the `makeup` plugin, you can now run the `make hello` command from any subdirectory, deep inside the project without navigating back and forth 👇
 
 ```bash
-# ~/repos/makeup
-$  ll
-   29B  Makefile
-   128B demofolder
-
 # ~/repos/makeup
 $ cd demo/level1/level2/level3
 
 # ~/repos/makeup/demofolder/level1/level2/level3
-$ make hello
+$ make hello # This would otherwise fail
+💄 Looking for Makefile's in parent directories...
 
-🧗 cd ..
-🧗 cd ..
-🧗 cd ..
-🧗 cd ..
+"Hello, World!" # Found the root Makefile and executed the target.
 
-"Hello, World!"
+$ pwd # Returns you back to where you executed the make command.
+~/repos/makeup/demo/level1/level2/level3
+```
+
+## 🛠️ Configuration
+
+You can customize the behavior of the `makeup` plugin by setting environment variables in your `.zshrc` file.
+
+```sh
+# ~/.zshrc
+
+# Configuration
+export MAKEUP_CONFIRM=true
+export MAKEUP_BASE_DIR="$HOME"
 
-# ~/repos/makeup/demofolder/level1/level2/level3
-$
 ```
 
+* `MAKEUP_CONFIRM`
+
+This variable controls whether you want a confirmation prompt before the script runs. If set to `true`, it will show you the directory where it will run the `make` command.
+
+* `MAKEUP_BASE_DIR`
+
+This variable sets the root directory where the script will stop searching for a `Makefile`. If not set, it defaults to your home directory (`$HOME`). You can set it to any directory you want the script to stop searching at.
+
+
 ## 🔧 Installation
 
-This plugin is still under development. To test it:
+### Oh-My-Zsh
 
-### 1. Clone the plugin
+```bash
+git clone https://github.com/arienshibani/makeup ${ZSH_CUSTOM:-~/.oh-my-zsh/custom}/plugins/makeup
+```
 
+Add to `.zshrc`:
 ```bash
-git clone https://github.com/arienshibani/makeup ~/makeup
+plugins=(... makeup)
 ```
 
-### 2. Source it in your Zsh session
+### Antigen
 
 ```bash
-source ~/makeup/makeup.plugin.zsh
+antigen bundle arienshibani/makeup
 ```
 
-### 3. Configuration
-
-The script supports two environment variables:
+### Zinit
 
-```sh
-MAKEUP_CONFIRM=false # true / false Whether you want a prompt which shows you which directory you run it in. The answer is stored in the current terminal session.
-MAKEUP_BASE_DIR="/" # Root directory where the script will give up.
+```bash
+zinit light arienshibani/makeup
 ```
 
-Use as follows:
+### zplug
 
-```sh
-# ~/.zshrc
+```bash
+zplug "arienshibani/makeup"
+```
 
-# Configuration
-export MAKEUP_CONFIRM=true
-export MAKEUP_BASE_DIR="$HOME"
+### Manual Installation
+
+```bash
+# Clone repository
+git clone https://github.com/arienshibani/makeup ~/.makeup
 
-# Load the plugin
-source ~/path/to/makeup.plugin.zsh
+# Add to .zshrc
+echo "source ~/.makeup/makeup.plugin.zsh" >> ~/.zshrc
 ```
+
+After installation, restart your shell or run `source ~/.zshrc`.

README.md

@@ -13,7 +13,7 @@ function make() {
   local base="${MAKEUP_BASE_DIR:-"/"}"
 
   # Climb up until we find a Makefile or reach the base directory
-  echo "🔎 Searching..."
+  echo "💄 Looking for Makefile in parent directories..."
   while [[ ! -e "$dir/Makefile" && "$dir" != "$base" ]]; do
     dir=$(dirname "$dir")
   done