alban
/
changelog
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
changelog for servers are serious business
4 Commits 1 Branch 0 Tags 182 KiB
Shell 100%
Go to file
alban e77830a144 [wip] There should be a plugin approach for output 2020-05-16 02:38:09 +02:00
hooks-content [enh] adds hooks contents 2020-05-15 09:46:56 +00:00
hooks-output [wip] There should be a plugin approach for output 2020-05-16 02:38:09 +02:00
.gitignore [wip] There should be a plugin approach for output 2020-05-16 02:38:09 +02:00
README.md [init] 2020-05-12 10:20:41 +02:00
changelog [wip] There should be a plugin approach for output 2020-05-16 02:38:09 +02:00

README.md

changelog : manage changes on a server

Based on the Masters Book of Serious Sysadmin's Best Practices Chapter, this script aims at unifying and simplifying the management of changelog files on a server.

Crash course

wget https://this.repo.srs.ly/alban/changelog/bla/bla/raw/changelog
chmod +x changelog
sudo ./changelog

The script will ask for your name if no CHANGELOG_USERNAME environment variable is found.

Then it will ask for a first change informations:

  • The nature of the change: which software / domain did you change? Why?
  • Some comments: How did you do it? What was happening? Is it fixed?

Limitations

  • Please note that to enter multiline comments, you have for now to escape newline characters using the \\\\n sequence. Ugly.

  • By default, it will attempt to create and edit /etc/changelog. You better be running it as root, by default.

Possible improvements

  • Enable a sudo requirement / ways to restart oneself as a root user
  • Enable simple multiline comments
  • Provide a way to attach files
  • Provide a way (plugins?) to report each change to a central server