Wie können Sie Änderungen an GitHub-Wikis verfolgen oder darüber informiert werden?
-
29-10-2019 - |
Frage
Gibt es Service-Hooks für GitHub -Wiki-Repositories?Gibt es einen anderen Mechanismus, den GitHub für mich bereitstellt, um Wiki-Änderungen zu verfolgen?
Lösung
Push-Ansatz: In der GitHub-API-Dokumentation finden Sie Informationen Dokumentation zum Einrichten von Service-Hooks , die für ein oder mehrere Ereignisse ausgelöst werden können. Das gollum
-Ereignis wird besonders jedes Mal ausgelöst, wenn eine Wiki-Seite aktualisiert wird.
JSON-basierter Pull-Ansatz: Sie können auch die Ereignis-HTTP-API nutzen Um eine JSON-formatierte Ausgabe der Ereignisse auf GitHub abzurufen, wenden Sie eine Filterung an, um die Ereignisse vom Typ GollumEvent
zu isolieren.
Unten ein kurzes jQuery-basiertes Beispiel
<html>
<head>
<title>Gollum events</title>
<script src="http://ajax.googleapis.com/ajax/libs/jquery/1.7.1/jquery.min.js"></script>
<script type="text/javascript">
$(function() {
$.getJSON('https://api.github.com/repos/holman/spark/events?callback=?', function(data) {
var list = $('#gollum-events');
$.each(data.data, function(key, val) {
if (val.type == "GollumEvent") {
$.each(val.payload.pages, function(key2, val2) {
list.append('<li id="' + key + '.' + key2 + '"><a href="' + val2.html_url + '">' + val2.page_name + '</a> [' + val.actor.login + ' @ ' + val.created_at + ']</li>');
});
}
});
});
});
</script>
</head>
<body>
<ul id="gollum-events"/>
</body>
</html>
Atombasierter Pull-Ansatz: Zu guter Letzt können Sie den Atom-Feed für Wiki-Änderungen abonnieren. Gehen Sie zum GitHub-Wiki-Bereich des Repositorys, wählen Sie die Unterregisterkarte Pages
aus, bewegen Sie den Mauszeiger über das orangefarbene Symbol, kopieren Sie den Link und fügen Sie ihn in Ihren bevorzugten RSS-Reader ein.
Update:
Es sieht so aus, als würde das RSS-Feed-Symbol für ein Wiki nicht mehr angezeigt.
Sie können die URL jedoch weiterhin selbst erstellen.
- Syntax:
https://github.com/:user/:repository/wiki.atom
- Beispiel: https:// github .com / holman / spark / wiki.atom
https://github.com/:user/:repository/wiki.atom
Andere Tipps
Ich habe einen Jenkins-Job eingerichtet, um unser GitHub-Wiki von https://github.com/ abzurufen.IQSS / dvn.wiki.git mit einem Build-Trigger von @daily.In einem Build-Schritt führe ich einen Shell-Befehl wie diesen aus, um uns eine E-Mail zu senden:
echo "Das DVN-Wiki auf GitHub wurde aktualisiert. Weitere Informationen finden Sie unter https://github.com/IQSS/dvn/wiki/_history "|mail -s "[dvn-wiki-notifications] update erkannt" dvn@example.com
Hier ist der Job, wenn jemand etwas sehen möchte: https://build.hmdc.harvard.edu:8443/job/dvn-wiki-notifications/