ChangeLog Generator…

I’ve been looking into source control and version control software to help manage and organise some of our code. The majority of them don’t seem to fit our workflow and are to restrictive or complicated for tiny projects. I’m a massive fan of the good old ChangeLog (https://en.wikipedia.org/wiki/Changelog) which does not scale well with larger projects.

So, I’ve built a little “one page” script (technically a few files if you include images for the GUI). Nice and simple app to manage a ChangeLog for a larger project but not quite big enough for full version management software.

Aims:

  • Make the change log easier to read.
  • Make it easier to record changes.
  • Conform to the standard format as much as possible.

I’ll probably be adding bits and bobs every now and then to be sure to check back. (such as searching and filtering)

Previous Changes:

Version 1.5:

  1. Color coding of ChangeLog
  2. Improved GUI from standard text
  3. Clickable emails
  4. Categories or Titles for logs
  5. Easier logging and better tracking accuracy
  6. Very simple password protection
  7. Custom settings: Change project name and change log location.

Version 1.6 (2012-03-21):

  1. Improved FireFox support.

Version 1.7 (2012-05-07): [previous screenshot “/2012/03/hmChangeLog.png“]

  1. Added a search/filter for changelog contents.
  2. Added toggle-able “Show Full Paths” option.
  3. Changed the password field type from “text” to “password”. 😛

Version 1.8 (2012-09-25):

  1. Changed GUI images and small layout details.
  2. Added “Documentation” type, to allow for app docs.
  3. Fixed apostrophe bug.
  4. Added support for “Unknown” types.
  5. Fixed change log generation comment date format.
Version 1.9 (2012-10-02):
  1. Fixed login error.
  2. Removed non-required image.
  3. Made it scalable for many projects. (Tutorial soon to come)
Version 2.0: (2012-10-04):
  1. Added the ability to list multiple files/paths. Simply use ” & ” between each one.
  2. Fixed the massive bug/fail where only one user could submit changes per day…
  3. General GUI improvements.
  4. Added “Reload” button, because browser reload keeps asking for confirmation if you have submitted a change recently. (due to it all being one file)
  5. Clicking the project title will take you back to the main change log page.
  6. Added “Anchors” (this is a bigy!) You can now use URL links to link to a specific change, date or date+user. They are similar to HTML anchors. (The Anchors are user readable e.g. “2012-04-10+Ben_Hoskins+2”, this keeps the whole ‘useable change log text without script mission’ in play.)
  7. Added the “Todo” change type.
  8. You can show/hide the Anchor links (e.g. “[#]”).
  9. Since Todo is now a thing, there needed to be an ability to strike/tick off done Todo’s. So I added “RE:” such as in emails, to refer to (and strikeout ) a previous change/todo simply type “RE:” followed by the it’s Anchor, followed by anything else you want to type.
  10. Added auto-RE:Anchor link. So you don’t have to type “RE:” etc. Just go to the change you want to refer-to/tick-off (via. clicking its Anchor link) and then click the “RE:Anchor” button and it will auto fill-in the “Add Change” form.

 

Current Version 2.2 (2012-12-28):
  1. Complete code rewrite.
  2. Efficiency and stability improvements.
  3. Input handling improvements.
  4. Security updates.
  5. Scalability improvements.
  6. UI improvements.
  7. EOU improvements.
  8. Many other improvements.

 

Feel free to download, use and mod. Licensed under the (https://en.wikipedia.org/wiki/Beerware) licence. So, you can do what ever you wish with it but it’s always awesome to give credit where credit is due.

Let me know if you find any bugs, have improvements or requests in the comments. Go mental.

Download Current Version hmChangeLog-2.2.zip

Download Old Versions: 1.5, 1.6, 1.7, 1.8, 1.9, 2.0.

ChangeLog Generator…

7 thoughts on “ChangeLog Generator…

  1. hozza says:

    Keep in mind the code is super rough… even by my standards 😛 it served it’s purpose though!

Leave a Reply

Your email address will not be published. Required fields are marked *