alban/changelog
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
changelog for servers are serious business
8 Commits 1 Branch 0 Tags 182 KiB
Shell 100%
4c81704049
Go to file
alban 4c81704049 [fix] There should be a config sample file
2020-05-19 10:14:40 +02:00
plugins-available [fix] Bit of renaming things 2020-05-18 01:10:06 +02:00
plugins-enabled [fix] Bit of renaming things 2020-05-18 01:10:06 +02:00
.gitignore [fix] Bit of renaming things 2020-05-18 01:10:06 +02:00
build.sh [enh] There should be a build script 2020-05-18 01:10:22 +02:00
changelog.sh [fix] it should use a config and app path managemen 2020-05-19 10:14:22 +02:00
config.sample.sh [fix] There should be a config sample file 2020-05-19 10:14:40 +02:00
README.md [init] 2020-05-12 10:20:41 +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