Archives/gitwatch
2
0
Fork 0
mirror of https://github.com/gitwatch/gitwatch synced 2024-11-15 06:12:52 +00:00
Code Issues Projects Releases Wiki Activity

added markdownlinter fixes and config file

Browse Source
This commit is contained in:
Alan Young 2021-03-07 11:53:51 -07:00
parent c658f3cad4
commit dc499835bb
2 changed files with 33 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
.markdown-lint.yml Normal file
View File

@ -0,0 +1,15 @@
---
# Linter rules doc:
# - https://github.com/DavidAnson/markdownlint
#
# This file is based off of the github action super-linter template:
# - https://github.com/github/super-linter/blob/master/TEMPLATES/.markdown-lint.yml
#
# Note:
# To comment out a single error:
# <!-- markdownlint-disable -->
# any violations you want
# <!-- markdownlint-restore -->
# We don't care about inline HTML
MD033: false

28
README.md
View File

@ -32,9 +32,9 @@ for you if `/usr/local/bin` is in your `$PATH`. You may need to invoke
`install` with `sudo`. `install` with `sudo`.
```sh ```sh
$ git clone https://github.com/gitwatch/gitwatch.git git clone https://github.com/gitwatch/gitwatch.git
$ cd gitwatch cd gitwatch
$ [sudo] install -b gitwatch.sh /usr/local/bin/gitwatch [sudo] install -b gitwatch.sh /usr/local/bin/gitwatch
``` ```
#### Update #### Update
@ -51,7 +51,7 @@ the command below. You may need to invoke `bpkg` with `sudo` when using the
`-g` flag. `-g` flag.
```sh ```sh
$ [sudo] bpkg install -g gitwatch/gitwatch [sudo] bpkg install -g gitwatch/gitwatch
``` ```
### Archlinux ### Archlinux
@ -63,16 +63,16 @@ for Archlinux. Install it with you favorite aur helper.
To run this script, you must have installed and globally available: To run this script, you must have installed and globally available:
* `git` ( [git/git](https://github.com/git/git) | http://www.git-scm.com ) * `git` ([git/git](https://github.com/git/git) | [git-scm](http://www.git-scm.com))
* `inotifywait` (part of **inotify-tools**: [rvoicilas/inotify-tools](https://github.com/rvoicilas/inotify-tools) ) * `inotifywait` (part of **[inotify-tools](https://github.com/rvoicilas/inotify-tools)**)
### Notes for Mac ### Notes for Mac
If running on OS X, you'll need to install the following Homebrew tools: If running on OS X, you'll need to install the following Homebrew tools:
```sh ```sh
$ brew install fswatch brew install fswatch
$ brew install coreutils brew install coreutils
``` ```
## What it does ## What it does
@ -95,6 +95,7 @@ forcefully stopped/killed), which will:
branch can be selected with `-b`) branch can be selected with `-b`)
Notes: Notes:
* the waiting period of 2 sec is added to allow for several changes to be * the waiting period of 2 sec is added to allow for several changes to be
written out completely before committing; depending on how fast the script written out completely before committing; depending on how fast the script
is executed, this might otherwise cause race conditions when watching is executed, this might otherwise cause race conditions when watching
@ -104,6 +105,7 @@ Notes:
## Usage ## Usage
`gitwatch.sh [-r <remote> [-b <branch>]] <file or directory to watch>`<br /> `gitwatch.sh [-r <remote> [-b <branch>]] <file or directory to watch>`<br />
It is expected that the watched file/directory are already in a git repository It is expected that the watched file/directory are already in a git repository
(the script will not create a repository). If a folder is being watched, this (the script will not create a repository). If a folder is being watched, this
will be watched fully recursively; this also means that all files and will be watched fully recursively; this also means that all files and
@ -135,7 +137,9 @@ the +x bit, will be executed upon startup, **by the root user account**. If
you want to start `gitwatch` from `rc.local`, the recommended way to call it you want to start `gitwatch` from `rc.local`, the recommended way to call it
is: is:
<!-- markdownlint-disable -->
`su -c "/absolute/path/to/script/gitwatch.sh /absolute/path/to/watched/file/or/folder" -l <username> &` `su -c "/absolute/path/to/script/gitwatch.sh /absolute/path/to/watched/file/or/folder" -l <username> &`
<!-- markdownlint-restore -->
The `<username>` bit should be replaced with your username or that of any The `<username>` bit should be replaced with your username or that of any
other (non-root) user account; it only needs write-access to the git other (non-root) user account; it only needs write-access to the git
@ -146,15 +150,17 @@ have other calls in `rc.local` after the mentioned line, because the
#### systemd #### systemd
- If installed to a path other than `/usr/bin/gitwatch`, modify * If installed to a path other than `/usr/bin/gitwatch`, modify
`gitwatch@.service` to suit `gitwatch@.service` to suit
- Create dir if it does not exist and copy systemd service file with `mkdir -p * Create dir if it does not exist and copy systemd service file with `mkdir -p
"$HOME/.config/systemd/user" && cp gitwatch@.service "$HOME/.config/systemd/user" && cp gitwatch@.service
$HOME/.config/systemd/user` $HOME/.config/systemd/user`
- Start and enable the service for a given path by running `systemctl --user * Start and enable the service for a given path by running `systemctl --user
--now enable gitwatch@$(systemd-escape "'-r url/to/repository' --now enable gitwatch@$(systemd-escape "'-r url/to/repository'
/path/to/folder").service` /path/to/folder").service`
## Other Articles ## Other Articles
### On the Gitwatch Wiki ### On the Gitwatch Wiki
* [How to install `gitwatch` as a Debian service with `supervisord`](https://github.com/gitwatch/gitwatch/wiki/gitwatch-as-a-service-on-Debian-with-supervisord) * [How to install `gitwatch` as a Debian service with `supervisord`](https://github.com/gitwatch/gitwatch/wiki/gitwatch-as-a-service-on-Debian-with-supervisord)