packtrack 3.0.1

A simple CLI for tracking mail packages
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122

# Run project tasks
This file defines and describes tasks that can be run with `mask`. 

Mask is a modern markdown-based replacement for `make`. The code blocks defined in this file are runnable via the `mask` CLI (try `mask --help`), and the surrounding markdown serves as the documentation.

See the [mask docs](https://github.com/jacobdeichert/mask) for more information.

<!-- A heading defines the command's name -->
## test

<!-- A blockquote defines the command's description -->
> Run all the tests

<!-- A code block defines the script to be executed -->
```sh
cargo test
```

## docs

> Hot-reload the documentation with `mkdocs`

```sh
mkdocs serve 
```

### docs bump 

> Create a new version of the docs

```sh 
version=$(cz version --project)
echo "Project version is $version"
regex="^([0-9]+)\.([0-9]+)\.([0-9]+)$"
if [[ $version =~ $regex ]]; then
    major="${BASH_REMATCH[1]}"
    minor="${BASH_REMATCH[2]}"
    major_minor="$major.$minor"
    echo "Truncated to docs version $major_minor"
else
    echo "Invalid version string format"
fi
mike set-default latest --allow-undefined
mike deploy $major_minor latest --update-aliases --push
```

## bump

> Create a new version of the project, docs, and changelog 

```sh
git-cliff -o CHANGELOG.md --bump \
&& git add CHANGELOG.md \
&& cz bump \
&& mask docs bump
```

## release 
> Release the current version to crates.io

```sh 
mask release cleanup
cargo publish
```

### cleanup 
> Clean up build artifacts

```sh
rm -rf target/
```

## ask (prompt)
> Ask the user a yes/no question (useful for scripting)

Returns a non-zero exit code if the answer is not "y", 

```sh
read -r -p "$prompt [y/N]: " response
if [[ ! "$response" =~ ^[Yy]$ ]]; then
echo "Aborted."
exit 1
fi
```

## changelog 

> Update the changelog with `git-cliff`

```sh
git-cliff -o CHANGELOG.md
```

Positional arguments

These are defined beside the command name within (round_brackets). They are required arguments that must be supplied for the command to run. The argument name is injected into the script's scope as an environment variable.

Example:

## pos (file) (test_case)

> Positional args example

~~~bash
echo "Testing $test_case in $file"
~~~

Optional arguments are defined within [square_brackets].

Example:

## opt [test_file]

> Optional args example

~~~bash
if [[ -n "$test_file" ]]; then
    echo "Run tests in $test_file..."
else
    echo "Running all tests...."
fi
~~~