⌈⌋ ⎇ branch:  freshcode


Update of "AutoupdateGithub"

Many hyperlinks are disabled.
Use anonymous login to enable hyperlinks.

Overview

Artifact ID: 901c07b93fb103a151a24aa40c45f6a03fb105d4
Page Name:AutoupdateGithub
Date: 2014-08-03 18:50:19
Original User: mario
Mimetype:text/x-markdown
Parent: 1917e14803420985b78aa20e146f8418573daa8a (diff)
Next f4befd6b970882a7b6b1959d944876a2c159bae4
Content

For GitHub-hosted projects there's a particular simple release autoupdate scheme. Just provide at least one link to your github-repo as primary Autoupdate URL, Homepage, Download or Other URL.

  • A projects tags.atom will be polled daily for version number updates.

  • http://github.com/$user/$project/releases is the preferred way to retrieve a changelog. The first bulleted task-list will be presumed to be individual change notes.

    This is what GitHub itself recommends for publishing releases. Albeit only major projects are utilizing it, e.g. /atom/atom.

  • As fallback $repo/compare/0.9.9...1.0.0 will be used for condensing commit logs into a summary.

    This is obviously not often a user-friendly changelog. Therefore it's rate limited. Which might incur delayed bugfix release announcements.

    For projects where this fallback repeatedly only generates developer/commit changelogs, it'll probably be moderated and disabled.

Version number prefixes like "v" will generally be stripped from tags. Some basic filter (removing "merged pull request xyz" entries) is generally applied.

State: functional, testing