🚚 installation | 📖 usage | 🙋 configuration | 🐚 shell integration | ⚗️ development | 💖 acknowledgements
mommy's here to support you! mommy will compliment you if things go well, and will encourage you if things are not going so well~
mommy is fully customizable, integrates with any shell, works on any system, and most importantly, loves you very much~ ❤️
🚚 installation top ▲
mommy works on any system. mommy is tested on ubuntu, debian, archlinux, fedora, nixpkgs, macos, freebsd, netbsd, openbsd, and windows~
don't see your favourite distro or package manager listed? need help? otherwise not satisfied? please open an issue~
find your operating system and package manager for the right instructions~
alpine linux
- homebrew (automatic updates)
installs from the mommy tap. (requires brew.)after installing, check the brew documentation on how to enable shell completions~brew tap fwdekker/mommy brew install mommy
- apk (github release) (manual updates)
# download latest package from github release curl -s https://api.github.com/repos/FWDekker/mommy/releases/latest | grep "browser_download_url.*\.apk" | cut -d : -f 2,3 | tr -d \" | xargs curl -sLOJ # install package sudo apk add --allow-untrusted ./mommy-*.apk
arch linux
- arch user repository (automatic updates)
installs from the arch user repository, allowing for automatic updates. you should probably use an aur helper to do this:# if you use yay yay -S mommy # if you use paru paru -S mommy # if you use aura aura -A mommy # and so on
- homebrew (automatic updates)
installs from the mommy tap. (requires brew.)after installing, check the brew documentation on how to enable shell completions~brew tap fwdekker/mommy brew install mommy
- pacman (github release) (manual updates)
# download latest package from github release curl -s https://api.github.com/repos/FWDekker/mommy/releases/latest | grep "browser_download_url.*\.pacman" | cut -d : -f 2,3 | tr -d \" | xargs curl -sLOJ # install package sudo pacman -U ./mommy-*.pacman
debian/ubuntu/apt-based
-
apt ≥2.2.4 (automatic updates)
this method requires apt v2.2.4 or newer. check your version of apt withapt -v
~installs from the mommy apt repository. the repository supports all architectures and suites~
sudo curl -fsSo /etc/apt/sources.list.d/mommy.sources \ https://raw.githubusercontent.com/FWDekker/apt-mommy/main/deb/mommy.sources sudo apt update sudo apt install mommy
-
apt <2.2.4 (automatic updates)
this method works on all versions of apt~installs from the mommy apt repository. the repository supports all architectures and suites~
check this page for details on what this code does~
sudo mkdir -m 0755 -p /etc/apt/keyrings/ curl -fsSL https://raw.githubusercontent.com/FWDekker/apt-mommy/main/deb/Release.key | sudo gpg --dearmor -o /etc/apt/keyrings/mommy.gpg echo "deb [signed-by=/etc/apt/keyrings/mommy.gpg] https://raw.githubusercontent.com/FWDekker/apt-mommy/main/deb/ ./" | sudo tee /etc/apt/sources.list.d/mommy.list > /dev/null sudo apt update sudo apt install mommy
-
homebrew (automatic updates)
installs from the mommy tap. (requires brew.)brew tap fwdekker/mommy brew install mommy
after installing, check the brew documentation on how to enable shell completions~
-
apt (github release) (manual updates)
# download latest package from github release curl -s https://api.github.com/repos/FWDekker/mommy/releases/latest | grep "browser_download_url.*\.deb" | cut -d : -f 2,3 | tr -d \" | xargs curl -sLOJ # install package sudo apt install ./mommy*.deb
freebsd
- pkg (github release) (manual updates)
# download latest package from github release curl -s https://api.github.com/repos/FWDekker/mommy/releases/latest | grep "browser_download_url.*\.freebsd" | cut -d : -f 2,3 | tr -d \" | xargs curl -sLOJ # install package sudo pkg add ./mommy-*.freebsd
macos
- homebrew (automatic updates)
installs from the mommy tap. (requires brew.)after installing, check the brew documentation on how to enable shell completions~brew tap fwdekker/mommy brew install mommy
- pkg (github release) (manual updates)
# download latest package from github release curl -s https://api.github.com/repos/FWDekker/mommy/releases/latest | grep "browser_download_url.*osx\.pkg" | cut -d : -f 2,3 | tr -d \" | xargs curl -sLOJ # install package sudo installer -pkg ./mommy*+osx.pkg -target /
netbsd
- pkg_add (github release) (manual updates)
# download latest package from github release curl -s https://api.github.com/repos/FWDekker/mommy/releases/latest | grep "browser_download_url.*netbsd\.tgz" | cut -d : -f 2,3 | tr -d \" | xargs curl -sLOJ # install package sudo pkg_add ./mommy-*+netbsd.tgz
nixpkgs/nixos
-
nix-shell (temporary)
if you're curious but not ready for commitments, usenix-shell
to temporarily install mommy:nix-shell -p mommy
-
home-manager (persistent)
if you use home manager, install mommy by adding the following to your home manager configuration:home.packages = with pkgs; [ mommy ];
you can configure mommy as follows:
home.packages = with pkgs; [ (mommy.override { mommySettings = { sweetie = "catgirl"; } }) ];
check the full list of configuration options. note that your nix configuration should use lowercase variable names~
-
nixos (persistent)
install mommy by adding the following to your nixos configuration (usually in/etc/nixos/configuration.nix
):environment.systemPackages = with pkgs; [ mommy ];
you can configure mommy as follows:
environment.systemPackages = with pkgs; [ (mommy.override { mommySettings = { sweetie = "catgirl"; } }) ];
check the full list of configuration options. note that your nix configuration should use lowercase variable names~
openbsd
- pkg_add (github release) (manual updates)
# download latest package from github release curl -s https://api.github.com/repos/FWDekker/mommy/releases/latest | grep "browser_download_url.*openbsd\.tgz" | cut -d : -f 2,3 | tr -d \" | xargs curl -sLOJ # install package sudo pkg_add -D unsigned ./mommy-*+openbsd.tgz
red hat/fedora/opensuse/rpm-based
- dnf (copr) (automatic updates)
installs from the copr repository. (requires thednf-plugins-core
package.)packages are signed bysudo dnf copr enable fwdekker/mommy sudo dnf install mommy
fwdekker#[email protected]
, check for fingerprintE332 C8E6 ADAA 58E4 1974 7CE2 CE16 3CFF 9F79 DD8A
~ - yum (copr) (automatic updates)
installs from the copr repository. (requires theyum-plugin-core
package.)packages are signed bysudo yum copr enable fwdekker/mommy sudo yum install mommy
fwdekker#[email protected]
, check for fingerprintE332 C8E6 ADAA 58E4 1974 7CE2 CE16 3CFF 9F79 DD8A
~ - homebrew (automatic updates)
installs from the mommy tap. (requires brew.)after installing, check the brew documentation on how to enable shell completions~brew tap fwdekker/mommy brew install mommy
- dnf (github release) (manual updates)
# download latest package from github release curl -s https://api.github.com/repos/FWDekker/mommy/releases/latest | grep "browser_download_url.*\.rpm" | cut -d : -f 2,3 | tr -d \" | xargs curl -sLOJ # install package sudo dnf install ./mommy-*.rpm
windows
for git bash or cygwin, see the instructions for using mommy without a package manager~
- wsl (automatic or manual updates)
follow any of the mommy installation instructions for your installed linux subsystem (default is ubuntu) or build mommy from source~ - msys2 (automatic or manual updates)
follow any of the mommy installation instructions for arch linux (except do not use the arch user repository method) or build mommy from source~
build from source and install
if you want to customise where and how mommy installs, you can just compile her code yourself~
-
prerequisites
-
clone repository
git clone https://github.com/FWDekker/mommy.git cd mommy
-
install
this step builds mommy's files and copies them into your system. the exact paths differ per system, so find the instructions that are right for your system.ℹ️ note
if you want to install mommy only for the current user, addprefix='~/.local/'
beforeinstall
~💡 tip
check the makefile for a list of all prefix variables you can override~- debian/ubuntu/apt-based
sudo make install/deb
- freebsd
sudo gmake install/freebsd
- macos
sudo gmake install/osxpkg
- netbsd
sudo gmake install/netbsd
- openbsd
sudo gmake install/openbsd
- windows
sudo make install
- all other unix systems
sudo make install
- debian/ubuntu/apt-based
-
test (optional)
if you want to make sure installation was successful, you can run tests using shellspec. run the following from inside the cloned mommy repositorygit clone https://github.com/shellspec/shellspec.git PATH="$(pwd)/shellspec/:$PATH" make system=1 test
some tests will be skipped, depending on which other programs you have installed~
-
uninstall (optional)
if you want to uninstall after runningmake install
, just run the same command as in step 3, except you replaceinstall
withuninstall
.uninstall might not work completely if you installed a different version than the one you're uninstalling. for the best results, run
mommy -v
, check the version number, rungit checkout <the version>
, and then perform the uninstallation~
use without installing
if you don't want to use a package manager but also don't want to bother with make
ing mommy, you can download a
universal build of mommy, and play around with that.
this will not install any files onto your system.
if you're here because you want to install mommy only for a specific user, the "build from source and install" option
is probably a better approach, though~
the script below downloads the latest stable release and extracts it for you.
if you don't want to use curl, just check the latest release in
your browser and download the file ending in +generic.tar.gz
manually~
# download latest archive from github release
curl -s https://api.github.com/repos/FWDekker/mommy/releases/latest | grep "browser_download_url.*generic\.tar\.gz" | cut -d : -f 2,3 | tr -d \" | xargs curl -sLOJ
# extract archive to `mommy`
tar -C ./ -xzf mommy-*.tar.gz
# invoke mommy
./mommy/usr/bin/mommy
check out how to use mommy, read all about ways you can configure mommy, and integrate mommy with your shell~
📖 usage top ▲
mommy processes (the output status of) a command and compliments you if the command succeeds and encourages you if it fails~
Tip
the recommended way of long-term mommy usage is to integrate mommy into your shell, so mommy will run after every command you run~
for reference, here's the three main ways to invoke mommy~
format | example | when to use |
---|---|---|
mommy [command] ... |
mommy npm test |
if you want mommy to respond to a single command~ |
mommy -e [command] |
mommy -e "ls -l | wc -l" |
if you want mommy when using | or > , or need mommy in a script~ |
mommy -s [status] |
mommy -s $? |
if you already ran a command and want mommy's help afterwards~ |
additionally, mommy knows a few extra options, which you can use to discover who mommy is and to tell mommy which configuration files she should use~
short option | long option | description |
---|---|---|
-h |
--help |
opens mommy's manual page~ |
-v |
--version |
displays mommy's version information~ |
-1 |
writes output to stdout instead of stderr~ | |
-c <file> |
--config=<file> |
tells mommy that she should read your config from <file> ~ |
-d <dirs> |
--global-config-dirs=<dirs> |
sets global configuration dirs to the colon-separated list in <dirs> ~ |
🙋 configuration top ▲
mommy's behavior can be modified using config files.
the easiest way to do so is to add your config to the file ~/.config/mommy/config.sh
.
you can also set up a global config file that is applied to all users, by default in /etc/mommy/config.sh
.
read more about the way config files are loaded~
mommy supports a lot of different settings.
if you want to configure the value of MOMMY_SWEETIE
, add the following line to your config file:
MOMMY_SWEETIE="catgirl"
make sure you do not put spaces around the =
, and you do put quotes ("
) around the value~
🔍 config file locations
when mommy runs, she will first load the system-wide global config file. after that, she will read the user-specific local config file, overriding the values from the global file~
- to find the global config file, mommy runs the following procedure.
- mommy determines the list of global config dirs.
- if a list is specified using a command-line option, that list is used.
- otherwise, the list consists of all directories in
$XDG_CONFIG_DIRS
, plus/etc/mommy
, plus/usr/local/etc/mommy/
.
- mommy traverses this list, and stops once she finds a directory that contains the file
config.sh
. this file will be the global config file~
- mommy determines the list of global config dirs.
- to find the local config file, mommy runs the following procedure.
- if a config file is specified using a command-line option, that file is used.
- if
$XDG_CONFIG_HOME
is defined, the file$XDG_CONFIG_HOME/mommy/config.sh
is used. - otherwise,
$HOME/.config/mommy/config.sh
is used~
👛 list of all settings
variable | description | list? | default |
---|---|---|---|
MOMMY_CAREGIVER |
what mommy calls herself | yes | mommy |
MOMMY_PRONOUNS |
mommy's pronouns for herself. should be three words separated by spaces, as in they them their (subject, object, possessive) |
yes | she her her |
MOMMY_SWEETIE |
what mommy calls you | yes | girl |
MOMMY_PREFIX |
what mommy puts at the start of each sentence | yes | <empty> |
MOMMY_SUFFIX |
what mommy puts at the end of each sentence | yes | ~ |
MOMMY_CAPITALIZE |
0 to start sentences in lowercase, 1 for uppercase, anything else to change nothing |
no | 0 |
MOMMY_COLOR |
color of mommy's text. you can use any xterm color code, or write lolcat to use lolcat (install separately). specify multiple colors separated by / to randomly select one. set to empty string for your terminal's default color |
yes | 005 |
MOMMY_COMPLIMENTS |
default compliment templates | yes | <various> |
MOMMY_COMPLIMENTS_EXTRA |
additional compliment templates you can specify | yes | <empty> |
MOMMY_COMPLIMENTS_ENABLED |
1 to enable compliments, anything else to disable |
no | 1 |
MOMMY_ENCOURAGEMENTS |
default encouragement templates | yes | <various> |
MOMMY_ENCOURAGEMENTS_EXTRA |
additional encouragement templates you can specify | yes | <empty> |
MOMMY_ENCOURAGEMENTS_ENABLED |
1 to enable encouragements, anything else to disable |
no | 1 |
MOMMY_FORBIDDEN_WORDS |
mommy will never give outputs that match forbidden strings. each entry is expressed as an extended regex (see also man grep ). to enforce this, mommy will filter out all templates that match at least one regex. as a failsafe, mommy will also check her final output after choosing and filling in the template, and will output nothing if she finds a forbidden string. also, if you want, you can replace literal characters with their octal (not hex!) escape sequences; for example, you can write \0155\0157\0155 instead of mom |
yes | <empty> |
MOMMY_IGNORED_STATUSES |
exit codes that mommy should never reply to. set to empty string to ignore nothing | yes | 130 |
🪣 how to configure lists
some of these settings support lists.
mommy chooses a random element from each list each time she is called by you.
(except for MOMMY_FORBIDDEN_WORDS
and MOMMY_IGNORED_STATUSES
, where mommy always considers all elements of the
list.)
in a list, elements are separated by a newline or by a /
.
elements that contain whitespace only, and elements that start with a #
are ignored~
- for example, if you set
then mommy will sometimes call you
MOMMY_SWEETIE="girl/kitten"
girl
, and sometimeskitten
~ - if you set
then mommy will call herself
MOMMY_CAREGIVER="mommy mummy/#daddy/caregiver"
mommy
,mummy
, orcaregiver
, but notdaddy
~ - if you set
then mommy may choose between
MOMMY_PRONOUNS="she her her/they them their"
mommy knows she loves her girl
andmommy knows they love their girl
(but notmommy knows they love her girl
)~ - if you set
then mommy will never use templates that contain
MOMMY_FORBIDDEN_WORDS="cat/dog"
cat
, and will never use templates that containdog
~
🧬 how to configure templates
you can add a list of your own compliments to either MOMMY_COMPLIMENTS
or
MOMMY_COMPLIMENTS_EXTRA
.
there is a slight difference between the two lists:
- if you want both the default and your own compliments, add your own compliments to
MOMMY_COMPLIMENTS_EXTRA
~ - if you want your own compliments and not the default compliments, add your own compliments to
MOMMY_COMPLIMENTS
~
and similarly so for encouragements~
inside compliments and encouragements, you can put placeholders that contain the random values that mommy chose.
for example, if you add the compliment %%CAREGIVER%% loves you
, and have MOMMY_CAREGIVER=your mommy
, then mommy
outputs your mommy loves you
~
variable | description |
---|---|
%%CAREGIVER%% |
what mommy calls herself |
%%THEY%% |
mommy's subject pronoun (e.g. they, she, he) |
%%THEM%% |
mommy's object pronoun (e.g. them, her, he) |
%%THEIR%% |
mommy's possessive pronoun (e.g. their, her, he) |
%%SWEETIE%% |
what mommy calls you |
%%N%% |
a newline |
%%S%% |
a forward slash (/ ) |
🐚 shell integration top ▲
instead of calling mommy for each command, you can fully integrate mommy with your shell to get mommy's output each time
you run any command.
here are some examples on how you can do that in various shells.
recall that you can add MOMMY_COMPLIMENTS_ENABLED=0
to your mommy config file to disable compliments while keeping
encouragements~
this is just a small list of possibilities. if you know of another way to integrate mommy, feel free to contribute them by opening a pull request!
🪅 bash
in bash you can set
PROMPT_COMMAND
to run
mommy after each command.
just add the following line to ~/.bashrc
:
PROMPT_COMMAND="mommy -1 -s \$?; $PROMPT_COMMAND"
![bash showing the text 'it's okay to make mistakes' after running a command that has failed](.github/img/demo.gif)
🐟 fish
in fish you can have mommy output a message on the right side of your prompt by creating
~/.config/fish/functions/fish_right_prompt.fish
with the following contents:
function fish_right_prompt
mommy -1 -s $status
end
if you have an oh my fish theme installed, check the docs of your theme to see if there's an easy way to extend the theme's right prompt. if not, you can either overwrite it with the above code, or copy-paste the theme's code into your own config file and then add mommy yourself~
![fish shell showing the text 'it's okay to make mistakes' in the right prompt after running a command that has failed](.github/img/fish.png)
📈 nushell
in nushell you can have mommy output a message on the right side of your prompt by adding the following line to your
~/.config/nushell/config.nu
file:
$env.PROMPT_COMMAND_RIGHT = {|| mommy -1 -s $env.LAST_EXIT_CODE }
![nushell showing the text 'just a little further, mommy knows you can do it' in the right prompt after running a command that has failed](.github/img/nushell.png)
🪟 powershell
the exact instructions depend on how and where you installed mommy~
-
disable mommy's color output
mommy's colors don't really work well in powershell, so you'll have to disable them~- wsl
if you want to run mommy through wsl, openwsl
and run# run this in wsl mkdir -p ~/.config/mommy echo "MOMMY_COLOR=" >> ~/.config/mommy/config.sh
- git bash
if you want to run mommy through git bash, run# run this in powershell [IO.Directory]::CreateDirectory("$HOME/.config/mommy") [IO.File]::WriteAllLines("$HOME/.config/mommy/config.sh", "MOMMY_COLOR=''")
- wsl
-
test prompt
change powershell's prompt to include mommy's message~- wsl
if you want to run mommy through wsl, run# run this in powershell function prompt { "$(wsl -e mommy -1 -s $([int][bool]::Parse(!$?)))> " }
- git bash
if you want to run mommy through git bash, and you downloaded mommy toC:\Users\username\mommy
, run# run this in powershell function prompt { "$(& "C:\Program Files\Git\bin\sh.exe" "C:/Users/username/mommy" -1 -s $([int][bool]::Parse(!$?)))> " }
- wsl
-
save prompt
now let's make this prompt persistent. in powershell, runnotepad $profile
to open your powershell settings, and add thefunction prompt [...]
line from above~ℹ️ note
if you get an error that this file does not exist, runnew-item -itemtype file -path $profile -force
to create it~ℹ️ note
if you get an error that you cannot run local scripts, runSet-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope LocalMachine
as admin, or sign the script~ -
improve prompt
the instructions above show the basics of using mommy in powershell. you can make it way cooler using a theme engine like oh-my-posh. for example, you can use background colors or display mommy in the right prompt instead of the left~
💤 zsh
depending on where you want mommy's output, the instructions are a bit different. you can either get the output above your prompt, or aligned to the right~
above the prompt
to get mommy's output on a separate line above your prompt, add the following line to ~/.zshrc
:
precmd() { mommy -1 -s $? }
to the right of each command
to get mommy's output on the same line as your prompt, aligned to the right, add the following to ~/.zshrc
:
set -o PROMPT_SUBST
RPS1='$(mommy -1 -s $?)' # using single quotes here is required!
and add the following to your mommy config:
MOMMY_COLOR=""
MOMMY_PREFIX="%F{005}/%F{006}"
MOMMY_SUFFIX="~%f"
normally, mommy sets colors using standard ansi color codes, but zsh's support is a bit special, resulting in zsh
miscalculating the prompt width, which looks like your prompt is misaligned or shifted.
to fix this, you should disable mommy's color feature and manually set colors in the prefix option.
to specify colors, use zsh's special syntax, where the numbers correspond to the
xterm color codes.
finally, the %f
in the suffix resets the colors~
![zsh showing the text 'never give up, my love' in the right prompt after running a command that has failed](.github/img/zsh.png)
🐌 other shells
as a generic method, in any posix shell (including sh
, ash
, dash
, bash
) you can change the prompt itself to
contain a message from mommy by setting the $PS1
variable:
PS1="\$(mommy -1 -s \$?)$PS1"
to improve the spacing, set MOMMY_SUFFIX="~ "
in mommy's config file.
add the above line to the config file for your shell (e.g. .bashrc
for bash
) to apply it each time you open the
shell.
some shells (dash
, pdksh
) do not have a config file like .bashrc
, but you can enable one by adding the following
line to ~/.profile
:
export ENV="$HOME/.shrc"
note that this will apply to all (non-login) posix shells that you open.
after that, add the above-mentioned line that defines PS1
to ~/.shrc
.
log out and back in, and mommy will appear in your shell~
✍️ renaming the mommy executable
if you use any of the above integrations, you don't have to call mommy directly.
if you don't want that, but also don't want to write mommy
, this section explains how you can instead write, say,
daddy
, marija
, or sinterklaas
~
mommy is installed in slightly different locations on different systems, but you can easily find where mommy is
installed with whereis mommy
:
$ whereis mommy
mommy: /usr/bin/mommy /usr/share/man/man1/mommy.1.gz
the exact output of whereis
differs depending on your system, but in this case you can see that the program is
installed in /usr/bin/mommy
(and the manual page in /usr/share/man/man1/mommy.1.gz
).
if whereis mommy
doesn't work, mommy is not on your path, but you can still find her with find / -name mommy
~
anyway, after finding mommy, you can just symlink using the following commands:
(if whereis
gave different paths than the ones above, then change these commands accordingly)
sudo ln -fs /usr/bin/mommy /usr/bin/daddy
sudo ln -fs /usr/share/man/man1/mommy.1.gz /usr/share/man/man1/daddy.1.gz
[!IMPORTANT] uninstalling mommy will not remove the manually created symlinks~
⚗️ development top ▲
this section explains how to build mommy from source, in case you want to help with development or for any other reason~
🎬 run
you can actually just directly run the script in src/main/sh/mommy
.
the only difference will be that the -h
and -v
options may not work correctly.
if that annoys you, run make build
after each change, and use build/bin/mommy
instead~
🧪 tests
- requirements
shellspec - test local code
- all tests
make test
- unit tests
make test/unit
- integration tests
make test/integration
- all tests
- test installed code
make system=1 test
- configuration
except forsystem=1
, test behaviour is configured with environment variables. check the various files insrc/test/
to find 'em all~
🏬 distribution
mommy is distributed in three ways:
- attached as binary packages to each github release,
- built on build servers,
- and available as source builds ("ports", basically) on a few servers.
let's go into them in more detail~
-
📦 binary packages
the binary packages attached to the github release are built with the makefile. runmake list
to see a list of build targets; you're looking for the ones starting withdist/
~to build the packages, you need at least gnu make, ruby, and fpm. (actually, you don't need fpm for netbsd and openbsd.) on debian-based systems, you already have gnu make, so you only need
sudo apt install ruby sudo gem install fpm
after that, just run
make dist/deb
(or better:mommy make dist/deb
), and a.deb
package will be built indist/
. runmake
ormake list
for a list of valid build targets. a special target isinstall
, which directly copies the files into the specified directories on your system. these directories can be changed by settingprefix
variables, as inmake prefix=/usr/ install
. i recommend runningmake --dry-run prefix=/usr/ install
first so you can verify that all directories are calculated correctly. check the makefile for more details~all systems can build packages for themselves without additional dependencies beyond those noted above. if you want to compile for a different system, you may need additional dependencies. for example, if you want to build packages for alpine linux, archlinux, and rpm from a debian-like system, you will respectively need
sudo apt install libarchive-tools rpm zstd
and then you can run
make dist/apk dist/pacman dist/rpm
unfortunately, packages for macos, netbsd, and openbsd cannot be built on systems other than themselves~
-
🏗️ build servers
build servers build mommy distributions on-demand for each release, and make the created packages available for all users. how sweet~- apt-mommy is a github-based apt repository that hosts mommy's
.deb
packages after they have been built in mommy's cd pipeline~ - copr builds packages for fedora and epel~
- apt-mommy is a github-based apt repository that hosts mommy's
-
🌱 source builds
some servers host instructions on how to build mommy, but don't do any work beyond that. users connect to the server, get the latest instructions, and their system builds mommy for them locally~- for arch linux, the arch user repository hosts the mommy package. a development mirror is hosted on github in aur-mommy~
- for homebrew, mommy has the homebrew-mommy repository on github, which is resolved automatically by the brew client based on the repository's name~
📯 release
main
always contains the latest stable version.
to release a new version, just use the deploy action,
which can be activated using a workflow_dispatch
event~
release checklists
-
before triggering deployment
- update
version
~ - update all changelogs~
- update
CHANGELOG.md
~- do not leave a placeholder section for
[unreleased]
, because it will end up like that in the.deb
'schangelog.gz
~ - remove empty subsections for the new release~
- ensure no line breaks are used as whitespace; github release notes use them as actual line breaks~
- do not leave a placeholder section for
- update
pkg/rpkg/mommy.spec.rpkg
if changes were made to copr's rpkg packaging process~ - update
pkg/fpm/deb.changelog
if changes were made to fpm's debian packaging process~ - update
pkg/fpm/rpm.changelog
if changes were made to fpm's rpm packaging process~
- update
- update acknowledgements in
README.md
~ - update promotional images in
.github/img/
~
- update
-
after triggering deployment
- a new github release is created automatically~
- aur-mommy
- updated automatically when
mommy
updates - always manually check deployment status~
- updated automatically when
- copr
- updated automatically when
mommy
updates - always manually check deployment status~
- updated automatically when
- apt-mommy
- updated automatically when
mommy
updates - always manually check deployment status~
- updated automatically when
- homebrew-mommy
- updated automatically when
mommy
updates - always manually check deployment status~
- updated automatically when
💖 acknowledgements top ▲
mommy recognises all contributors, no matter the size of the contribution. if mommy should add, remove, or change anything here, open an issue or contact the author~
- mommy thanks aria beingessner for creating cargo-mommy, which inspired mommy to spawn herself into existence~
- mommy thanks austin burk for creating shell-mommy and contributing to the mommy-sphere; mommy did not know about shell-mommy before embarking on her journey, but loves her very much~
- mommy thanks natawie for suggesting publishing mommy on copr and writing the zsh completions~
- mommy thanks amber sprenkels for reporting a bug, sharing great ideas, and making mommy talk less like a robot~
- mommy thanks wei he for creating socialify, which mommy uses for her github social preview~
- mommy thanks ckie for bringing mommy to nixpkgs, several neat improvements, and for maintaining the nixpkg~
- mommy thanks aemogie. for telling her how to integrate with nushell~
- mommy thanks maximilian downey twiss for bumping mommy's actions to their latest versions~
- mommy thanks fuel-pcbox for her suggestion of supporting regexes for forbidden words~
- mommy thanks satyam singh niranjan for suggesting powershell support~