SVNNOTIFY(1p)

πŸ“¦
version 2.87 Β· 2 versions
  • 2.87 Β· debian bookworm, debian trixie, ubuntu noble, ubuntu resolute, ubuntu stonking (latest)
  • 2.87 Β· ubuntu jammy
, in debian bookworm, debian trixie, ubuntu noble, ubuntu resolute, ubuntu stonking

NAME πŸ’–

okay bestie, gather round, because this is svnnotify from the SVNNOTIFY(1p) manual β€” it's the little tool that yells at your group chat (well, your inbox) every time somebody commits to a Subversion repo. It's giving Subversion activity notification. no cap. πŸ¦‹


✨ USAGE ✨

like, the entire vibe in one line:

svnnotify --repos-path "$1" --revision "$2" [options]

that's it. that's the whole thing. you feed it a repo path and a revision and it goes off. πŸŽ€


πŸ’… OPTIONS πŸ’…

okay this is the long part but literally every single one matters, so stay with me bestie, we're doing all of them:

  • -p, --repos-path PATH β€” the path to the Subversion repository. Required. no repos, no party. πŸ’€
  • -r, --revision REVISION β€” the commit revision number. Required. again, non-negotiable.
  • -t, --to ADDRESS β€” the email address the notification gets sent to. Required unless you're using --to-regex-map.
  • -x, --to-regex-map TO=REGEX β€” a mapping between a destination email address and a regular expression that gets matched against the directories touched by the commit. Required unless you use --to or --to-email-map. the way it's literally routing your mail by folder, iconic. 🧚
  • --to-email-map REGEX=TO β€” the inverse of --to-regex-map: you map a regular expression to an email address instead. Required unless you use --to or --to-regex-map.
  • -f, --from ADDRESS β€” the email address that goes in the From header. who's sending this, bestie?
  • -D, --user-domain DOMAIN β€” domain name that gets appended to the username so the From header has a full, complete email address. ✨
  • -l, --svnlook SVNLOOK β€” where the svnlook executable lives.
  • -s, --sendmail SENDMAIL β€” where the sendmail executable lives.
  • -E, --set-sender β€” sets the envelope sender to the from address. lowkey important, don't sleep on it.
  • --smtp ADDRESS β€” the address of an SMTP server.
  • --smtp-user USERNAME β€” username for authenticating to a SMTP server.
  • --smtp-pass PASSWORD β€” password for authenticating to a SMTP server. 🀫
  • --smtp-port PORT β€” the port to connect to on the SMTP server.
  • --smtp-tls β€” enables a TLS/SSL connection to the SMTP server. secure-ish queen. πŸ‘‘
  • -c, --encoding ENCODING β€” the character encoding used for reading and writing data.
  • --svn-encoding ENCODING β€” the character encoding of the log message and the repository files.
  • --diff-encoding ENCODING β€” the character encoding of the repository files. (yes, just the files this time πŸ“)
  • -g, --language LANGUAGE β€” the value for the Content-Language header and the $LANG environment variable.
  • -d, --with-diff β€” include the diff in the message. showing your work, we love that. πŸ”₯
  • -a, --attach-diff β€” attach the diff to the message instead.
  • -w, --diff-switches SWITCHES β€” switches to pass to svnlook diff.
  • --diff-content-type TYPE β€” sets the Content-Type for diff attachments.
  • -R, --reply-to ADDRESS β€” the address for the Reply-To header.
  • --add-header NAME=VALUE β€” adds an extra header to the email. custom queen behavior.
  • -P, --subject-prefix PREFIX β€” a string to prepend to the subject line.
  • -C, --subject-cx β€” include the context of the commit in the subject. 🌈
  • -X, --strip-cx-regex β€” a regex to remove part of the CX file name from the subject.
  • -O, --no-first-line β€” do not include the first line of the log message in the subject.
  • -i, --max-sub-length LENGTH β€” the maximum size of the subject line. keep it cute, keep it short. πŸŽ€
  • -e, --max-diff-length LENGTH β€” the maximum size of the diff output.
  • -H, --handler HANDLER β€” the notification handler, like "HTML".
  • -F, --filter FILTER β€” an output filter, like "Markdown".
  • -A, --author-url URL β€” include a link to the specified author URL.
  • -U, --revision-url URL β€” include links to the specified Revision URL.
  • -T, --rt-url URL β€” include links to the specified Request Tracker URL.
  • -B, --bugzilla-url URL β€” include links to the specified Bugzilla URL.
  • -J, --jira-url URL β€” include links to the specified JIRA URL.
  • -G, --gnats-url URL β€” include links to the specified Gnats URL.
  • --ticket-map REGEX=URL β€” a regex and URL for custom ticket identifiers. making your own rules fr fr.
  • --header HEADER β€” text header to display before the body.
  • --footer FOOTER β€” text footer to display at the end of the body.
  • -V, --verbose β€” incremental verbose mode. it just keeps talking. πŸ’€
  • -h, --help β€” prints this usage statement and exits.
  • -m, --man β€” prints the complete documentation and exits. (the full lore drop)
  • -v, --version β€” prints the version number and exits.
ngl, more options may be supported by whatever subclass of SVN::Notify you specified with the --handler option, or by filters you specified with the --filter option. so consult the docs for those relevant modules, bestie, because there's more where that came from. 🫢

🌸 SEE ALSO 🌸

see SVN::Notify for the complete documentation. and if you're having issues with character encodings (and honestly, who isn't 😭), see especially the Character Encoding Support section. that's your girl.


πŸ’œ AUTHOR πŸ’œ

David E. Wheeler <david@justatheory.com> β€” absolute legend, main character energy, we stan. πŸ‘‘


Copyright (c) 2004-2018 David E. Wheeler. Some Rights Reserved.

This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself.


and that's the whole page, bestie!! πŸ¦‹βœ¨ this was written against perl v5.36.0, dated 2022-11-20, and it's the SVNNOTIFY(1p) manual β€” go commit something cute πŸ’…πŸ’–

πŸ“¦ where this page comes from