66 lines
1.5 KiB
Markdown
66 lines
1.5 KiB
Markdown
# Documentation
|
|
|
|
## Initiate again
|
|
|
|
Rk: useful when timezone has changed or ghostty command has been installed afterwards
|
|
may require SUDO privilege
|
|
|
|
`miaou-bash --self-upgrade`
|
|
|
|
## debug, use of MIAOU_DEBUG
|
|
|
|
```bash
|
|
MIAOU_DEBUG=true miaou-bash <<EOF
|
|
echo this is still fine
|
|
false
|
|
echo SHOULD NOT APPEAR
|
|
EOF
|
|
```
|
|
|
|
## hooks.d/after-upgrade
|
|
|
|
To launch optional scripts after 'upgrade', you can create any hook regarding:
|
|
|
|
1. script should be stored in "$MIAOU_BASH_DIR/hooks.d/
|
|
2. script should be named with prefix 'after-upgrade', example: `after-upgrade-1.bash`
|
|
3. script should be executable, ie: `chmod +x after-upgrade-1.bash`
|
|
|
|
Be aware: no matter a failure happens during processing a hook, it will get bypassed!
|
|
As so the whole process of upgrading keeps running on.
|
|
|
|
Rk: hooks.d/ respects natural order,
|
|
ie: `after-upgrade-0.bash` will perform before `after-upgrade-1.bash`
|
|
|
|
## IDEA
|
|
|
|
### distinguish heredoc over pipe
|
|
|
|
```bash
|
|
miaou-bash <<EOF
|
|
echo HEREDOC
|
|
EOF
|
|
```
|
|
|
|
```bash
|
|
miaou-bash < <(echo 'echo PIPE1')
|
|
```
|
|
|
|
```bash
|
|
echo 'echo PIPE2' | miaou-bash
|
|
```
|
|
|
|
---
|
|
|
|
See Also: [Bash Tips](./bash_tips.md)
|
|
|
|
---
|
|
|
|
## TODO
|
|
|
|
* [ ] prompt should show up version with `+` when there is more than one commit,
|
|
not yet versioned. ie: v0.0.0 + 2 commits more should display v0.0.0+
|
|
* [ ] semver_git_tag should append `RELEASE_NOTES.md` from this TODO markdown file,
|
|
providing that NEW NOTE section below contains appropriate items
|
|
to fulfill the current release note
|
|
* [ ] git log <LATEST_TAG>..HEAD --oneline
|