Browse Source

Add Travis-CI

gh-pages
Kegan Dougal 8 years ago
parent
commit
b1e4986a08
  1. 11
      pkg/github.com/index.html
  2. 11
      pkg/github.com/matrix-org/go-neb/index.html
  3. 8
      pkg/github.com/matrix-org/go-neb/matrix/index.html
  4. 4
      pkg/github.com/matrix-org/go-neb/services/guggy/index.html
  5. 11
      pkg/github.com/matrix-org/go-neb/services/index.html
  6. 363
      pkg/github.com/matrix-org/go-neb/services/travisci/index.html
  7. 11
      pkg/github.com/matrix-org/index.html

11
pkg/github.com/index.html

@ -1021,6 +1021,17 @@
<tr>
<td class="pkg-name" style="padding-left: 60px;">
<a href="matrix-org/go-neb/services/travisci/index.html">travisci</a>
</td>
<td class="pkg-synopsis">
Package travisci implements a Service capable of processing webhooks from Travis-CI.
</td>
</tr>
<tr> <tr>
<td class="pkg-name" style="padding-left: 40px;"> <td class="pkg-name" style="padding-left: 40px;">
<a href="matrix-org/go-neb/types/index.html">types</a> <a href="matrix-org/go-neb/types/index.html">types</a>

11
pkg/github.com/matrix-org/go-neb/index.html

@ -353,6 +353,17 @@
<tr>
<td class="pkg-name" style="padding-left: 20px;">
<a href="services/travisci/index.html">travisci</a>
</td>
<td class="pkg-synopsis">
Package travisci implements a Service capable of processing webhooks from Travis-CI.
</td>
</tr>
<tr> <tr>
<td class="pkg-name" style="padding-left: 0px;"> <td class="pkg-name" style="padding-left: 0px;">
<a href="types/index.html">types</a> <a href="types/index.html">types</a>

8
pkg/github.com/matrix-org/go-neb/matrix/index.html

@ -326,7 +326,7 @@ Client represents a Matrix client.
<h3 id="NewClient">func <a href="http://localhost:6060/src/github.com/matrix-org/go-neb/matrix/matrix.go?s=13306:13405#L417">NewClient</a></h3>
<h3 id="NewClient">func <a href="http://localhost:6060/src/github.com/matrix-org/go-neb/matrix/matrix.go?s=13316:13415#L417">NewClient</a></h3>
<pre>func NewClient(httpClient *<a href="../../../../net/http/index.html">http</a>.<a href="../../../../net/http/index.html#Client">Client</a>, homeserverURL *<a href="../../../../net/url/index.html">url</a>.<a href="../../../../net/url/index.html#URL">URL</a>, accessToken, userID <a href="../../../../builtin/index.html#string">string</a>) *<a href="index.html#Client">Client</a></pre> <pre>func NewClient(httpClient *<a href="../../../../net/http/index.html">http</a>.<a href="../../../../net/http/index.html#Client">Client</a>, homeserverURL *<a href="../../../../net/url/index.html">url</a>.<a href="../../../../net/url/index.html#URL">URL</a>, accessToken, userID <a href="../../../../builtin/index.html#string">string</a>) *<a href="index.html#Client">Client</a></pre>
<p> <p>
NewClient creates a new Matrix Client ready for syncing NewClient creates a new Matrix Client ready for syncing
@ -385,7 +385,7 @@ SetDisplayName sets the user&#39;s profile display name
<h3 id="Client.StopSync">func (*Client) <a href="http://localhost:6060/src/github.com/matrix-org/go-neb/matrix/matrix.go?s=10755:10784#L319">StopSync</a></h3>
<h3 id="Client.StopSync">func (*Client) <a href="http://localhost:6060/src/github.com/matrix-org/go-neb/matrix/matrix.go?s=10765:10794#L319">StopSync</a></h3>
<pre>func (cli *<a href="index.html#Client">Client</a>) StopSync()</pre> <pre>func (cli *<a href="index.html#Client">Client</a>) StopSync()</pre>
<p> <p>
StopSync stops the ongoing sync started by Sync. StopSync stops the ongoing sync started by Sync.
@ -396,7 +396,7 @@ StopSync stops the ongoing sync started by Sync.
<h3 id="Client.Sync">func (*Client) <a href="http://localhost:6060/src/github.com/matrix-org/go-neb/matrix/matrix.go?s=6649:6674#L192">Sync</a></h3>
<h3 id="Client.Sync">func (*Client) <a href="http://localhost:6060/src/github.com/matrix-org/go-neb/matrix/matrix.go?s=6659:6684#L192">Sync</a></h3>
<pre>func (cli *<a href="index.html#Client">Client</a>) Sync()</pre> <pre>func (cli *<a href="index.html#Client">Client</a>) Sync()</pre>
<p> <p>
Sync starts syncing with the provided Homeserver. This function will be invoked continually. Sync starts syncing with the provided Homeserver. This function will be invoked continually.
@ -419,7 +419,7 @@ UploadLink uploads an HTTP URL and then returns an MXC URI.
<h3 id="Client.UploadToContentRepo">func (*Client) <a href="http://localhost:6060/src/github.com/matrix-org/go-neb/matrix/matrix.go?s=5633:5747#L160">UploadToContentRepo</a></h3>
<h3 id="Client.UploadToContentRepo">func (*Client) <a href="http://localhost:6060/src/github.com/matrix-org/go-neb/matrix/matrix.go?s=5643:5757#L160">UploadToContentRepo</a></h3>
<pre>func (cli *<a href="index.html#Client">Client</a>) UploadToContentRepo(content <a href="../../../../io/index.html">io</a>.<a href="../../../../io/index.html#Reader">Reader</a>, contentType <a href="../../../../builtin/index.html#string">string</a>, contentLength <a href="../../../../builtin/index.html#int64">int64</a>) (<a href="../../../../builtin/index.html#string">string</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre> <pre>func (cli *<a href="index.html#Client">Client</a>) UploadToContentRepo(content <a href="../../../../io/index.html">io</a>.<a href="../../../../io/index.html#Reader">Reader</a>, contentType <a href="../../../../builtin/index.html#string">string</a>, contentLength <a href="../../../../builtin/index.html#int64">int64</a>) (<a href="../../../../builtin/index.html#string">string</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
<p> <p>
UploadToContentRepo uploads the given bytes to the content repository and returns an MXC URI. UploadToContentRepo uploads the given bytes to the content repository and returns an MXC URI.

4
pkg/github.com/matrix-org/go-neb/services/guggy/index.html

@ -190,7 +190,7 @@ ServiceType of the Guggy service
<h2 id="Service">type <a href="http://localhost:6060/src/github.com/matrix-org/go-neb/services/guggy/guggy.go?s=776:918#L31">Service</a></h2>
<h2 id="Service">type <a href="http://localhost:6060/src/github.com/matrix-org/go-neb/services/guggy/guggy.go?s=809:951#L33">Service</a></h2>
<pre>type Service struct { <pre>type Service struct {
<a href="../../types/index.html">types</a>.<a href="../../types/index.html#DefaultService">DefaultService</a> <a href="../../types/index.html">types</a>.<a href="../../types/index.html#DefaultService">DefaultService</a>
<span class="comment">// The Guggy API key to use when making HTTP requests to Guggy.</span> <span class="comment">// The Guggy API key to use when making HTTP requests to Guggy.</span>
@ -220,7 +220,7 @@ Example request:
<h3 id="Service.Commands">func (*Service) <a href="http://localhost:6060/src/github.com/matrix-org/go-neb/services/guggy/guggy.go?s=1056:1121#L40">Commands</a></h3>
<h3 id="Service.Commands">func (*Service) <a href="http://localhost:6060/src/github.com/matrix-org/go-neb/services/guggy/guggy.go?s=1089:1154#L42">Commands</a></h3>
<pre>func (s *<a href="index.html#Service">Service</a>) Commands(client *<a href="../../matrix/index.html">matrix</a>.<a href="../../matrix/index.html#Client">Client</a>) []<a href="../../types/index.html">types</a>.<a href="../../types/index.html#Command">Command</a></pre> <pre>func (s *<a href="index.html#Service">Service</a>) Commands(client *<a href="../../matrix/index.html">matrix</a>.<a href="../../matrix/index.html#Client">Client</a>) []<a href="../../types/index.html">types</a>.<a href="../../types/index.html#Command">Command</a></pre>
<p> <p>
Commands supported: Commands supported:

11
pkg/github.com/matrix-org/go-neb/services/index.html

@ -184,6 +184,17 @@
</tr> </tr>
<tr>
<td class="pkg-name" style="padding-left: 0px;">
<a href="travisci/index.html">travisci</a>
</td>
<td class="pkg-synopsis">
Package travisci implements a Service capable of processing webhooks from Travis-CI.
</td>
</tr>
</table> </table>
</div> </div>

363
pkg/github.com/matrix-org/go-neb/services/travisci/index.html

@ -0,0 +1,363 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="theme-color" content="#375EAB">
<title>travisci - The Go Programming Language</title>
<link type="text/css" rel="stylesheet" href="../../../../../../lib/godoc/style.css">
<link rel="stylesheet" href="../../../../../../lib/godoc/jquery.treeview.css">
<script type="text/javascript">window.initFuncs = [];</script>
</head>
<body>
<div id='lowframe' style="position: fixed; bottom: 0; left: 0; height: 0; width: 100%; border-top: thin solid grey; background-color: white; overflow: auto;">
...
</div><!-- #lowframe -->
<div id="topbar" class="wide"><div class="container">
<div class="top-heading" id="heading-wide"><a href="http://localhost:6060/">The Go Programming Language</a></div>
<div class="top-heading" id="heading-narrow"><a href="http://localhost:6060/">Go</a></div>
<a href="index.html#" id="menu-button"><span id="menu-button-arrow">&#9661;</span></a>
<form method="GET" action="http://localhost:6060/search">
<div id="menu">
<a href="http://localhost:6060/doc/">Documents</a>
<a href="http://localhost:6060/pkg/">Packages</a>
<a href="http://localhost:6060/project/">The Project</a>
<a href="http://localhost:6060/help/">Help</a>
<a href="http://localhost:6060/blog/">Blog</a>
<input type="text" id="search" name="q" class="inactive" value="Search" placeholder="Search">
</div>
</form>
</div></div>
<div id="page" class="wide">
<div class="container">
<h1>Package travisci</h1>
<div id="nav"></div>
<!--
Copyright 2009 The Go Authors. All rights reserved.
Use of this source code is governed by a BSD-style
license that can be found in the LICENSE file.
-->
<!--
Note: Static (i.e., not template-generated) href and id
attributes start with "pkg-" to make it impossible for
them to conflict with generated attributes (some of which
correspond to Go identifiers).
-->
<script type='text/javascript'>
document.ANALYSIS_DATA = null;
document.CALLGRAPH = null;
</script>
<div id="short-nav">
<dl>
<dd><code>import "github.com/matrix-org/go-neb/services/travisci"</code></dd>
</dl>
<dl>
<dd><a href="index.html#pkg-overview" class="overviewLink">Overview</a></dd>
<dd><a href="index.html#pkg-index" class="indexLink">Index</a></dd>
</dl>
</div>
<!-- The package's Name is printed as title by the top-level template -->
<div id="pkg-overview" class="toggleVisible">
<div class="collapsed">
<h2 class="toggleButton" title="Click to show Overview section">Overview ▹</h2>
</div>
<div class="expanded">
<h2 class="toggleButton" title="Click to hide Overview section">Overview ▾</h2>
<p>
Package travisci implements a Service capable of processing webhooks from Travis-CI.
</p>
</div>
</div>
<div id="pkg-index" class="toggleVisible">
<div class="collapsed">
<h2 class="toggleButton" title="Click to show Index section">Index ▹</h2>
</div>
<div class="expanded">
<h2 class="toggleButton" title="Click to hide Index section">Index ▾</h2>
<!-- Table of contents for API; must be named manual-nav to turn off auto nav. -->
<div id="manual-nav">
<dl>
<dd><a href="index.html#pkg-constants">Constants</a></dd>
<dd><a href="index.html#Service">type Service</a></dd>
<dd>&nbsp; &nbsp; <a href="index.html#Service.OnReceiveWebhook">func (s *Service) OnReceiveWebhook(w http.ResponseWriter, req *http.Request, cli *matrix.Client)</a></dd>
<dd>&nbsp; &nbsp; <a href="index.html#Service.PostRegister">func (s *Service) PostRegister(oldService types.Service)</a></dd>
<dd>&nbsp; &nbsp; <a href="index.html#Service.Register">func (s *Service) Register(oldService types.Service, client *matrix.Client) error</a></dd>
</dl>
</div><!-- #manual-nav -->
<h4>Package files</h4>
<p>
<span style="font-size:90%">
<a href="http://localhost:6060/src/github.com/matrix-org/go-neb/services/travisci/travisci.go">travisci.go</a>
<a href="http://localhost:6060/src/github.com/matrix-org/go-neb/services/travisci/verify.go">verify.go</a>
</span>
</p>
</div><!-- .expanded -->
</div><!-- #pkg-index -->
<div id="pkg-callgraph" class="toggle" style="display: none">
<div class="collapsed">
<h2 class="toggleButton" title="Click to show Internal Call Graph section">Internal call graph ▹</h2>
</div> <!-- .expanded -->
<div class="expanded">
<h2 class="toggleButton" title="Click to hide Internal Call Graph section">Internal call graph ▾</h2>
<p>
In the call graph viewer below, each node
is a function belonging to this package
and its children are the functions it
calls&mdash;perhaps dynamically.
</p>
<p>
The root nodes are the entry points of the
package: functions that may be called from
outside the package.
There may be non-exported or anonymous
functions among them if they are called
dynamically from another package.
</p>
<p>
Click a node to visit that function's source code.
From there you can visit its callers by
clicking its declaring <code>func</code>
token.
</p>
<p>
Functions may be omitted if they were
determined to be unreachable in the
particular programs or tests that were
analyzed.
</p>
<!-- Zero means show all package entry points. -->
<ul style="margin-left: 0.5in" id="callgraph-0" class="treeview"></ul>
</div>
</div> <!-- #pkg-callgraph -->
<h2 id="pkg-constants">Constants</h2>
<pre>const <span id="DefaultTemplate">DefaultTemplate</span> = (`%{repository}#%{build_number} (%{branch} - %{commit} : %{author}): %{message}
Change view : %{compare_url}
Build details : %{build_url}`)</pre>
<p>
DefaultTemplate contains the template that will be used if none is supplied.
This matches the default mentioned at: <a href="https://docs.travis-ci.com/user/notifications#Customizing-slack-notifications">https://docs.travis-ci.com/user/notifications#Customizing-slack-notifications</a>
</p>
<pre>const <span id="ServiceType">ServiceType</span> = &#34;travis-ci&#34;</pre>
<p>
ServiceType of the Travis-CI service.
</p>
<h2 id="Service">type <a href="http://localhost:6060/src/github.com/matrix-org/go-neb/services/travisci/travisci.go?s=1582:3020#L41">Service</a></h2>
<pre>type Service struct {
<a href="../../types/index.html">types</a>.<a href="../../types/index.html#DefaultService">DefaultService</a>
<span class="comment">// The URL which should be added to .travis.yml - Populated by Go-NEB after Service registration.</span>
WebhookURL <a href="../../../../../builtin/index.html#string">string</a> `json:&#34;webhook_url&#34;`
<span class="comment">// A map from Matrix room ID to Github-style owner/repo repositories.</span>
Rooms map[<a href="../../../../../builtin/index.html#string">string</a>]struct {
<span class="comment">// A map of &#34;owner/repo&#34; to configuration information</span>
Repos map[<a href="../../../../../builtin/index.html#string">string</a>]struct {
<span class="comment">// The template string to use when creating notifications.</span>
<span class="comment">//</span>
<span class="comment">// This is identical to the format of Slack Notifications for Travis-CI:</span>
<span class="comment">// https://docs.travis-ci.com/user/notifications#Customizing-slack-notifications</span>
<span class="comment">//</span>
<span class="comment">// The following variables are available:</span>
<span class="comment">// repository_slug: your GitHub repo identifier (like svenfuchs/minimal)</span>
<span class="comment">// repository_name: the slug without the username</span>
<span class="comment">// build_number: build number</span>
<span class="comment">// build_id: build id</span>
<span class="comment">// branch: branch build name</span>
<span class="comment">// commit: shortened commit SHA</span>
<span class="comment">// author: commit author name</span>
<span class="comment">// commit_message: commit message of build</span>
<span class="comment">// commit_subject: first line of the commit message</span>
<span class="comment">// result: result of build</span>
<span class="comment">// message: Travis CI message to the build</span>
<span class="comment">// duration: total duration of all builds in the matrix</span>
<span class="comment">// elapsed_time: time between build start and finish</span>
<span class="comment">// compare_url: commit change view URL</span>
<span class="comment">// build_url: URL of the build detail</span>
Template <a href="../../../../../builtin/index.html#string">string</a> `json:&#34;template&#34;`
} `json:&#34;repos&#34;`
} `json:&#34;rooms&#34;`
<span class="comment">// contains filtered or unexported fields</span>
}</pre>
<p>
Service contains the Config fields for the Travis-CI service.
</p>
<p>
This service will send notifications into a Matrix room when Travis-CI sends
webhook events to it. It requires a public domain which Travis-CI can reach.
Notices will be sent as the service user ID.
</p>
<p>
Example JSON request:
</p>
<pre>{
rooms: {
&#34;!ewfug483gsfe:localhost&#34;: {
repos: {
&#34;matrix-org/go-neb&#34;: {
template: &#34;%{repository}#%{build_number} (%{branch} - %{commit} : %{author}): %{message}\nBuild details : %{build_url}&#34;
}
}
}
}
}
</pre>
<h3 id="Service.OnReceiveWebhook">func (*Service) <a href="http://localhost:6060/src/github.com/matrix-org/go-neb/services/travisci/travisci.go?s=6648:6744#L171">OnReceiveWebhook</a></h3>
<pre>func (s *<a href="index.html#Service">Service</a>) OnReceiveWebhook(w <a href="../../../../../net/http/index.html">http</a>.<a href="../../../../../net/http/index.html#ResponseWriter">ResponseWriter</a>, req *<a href="../../../../../net/http/index.html">http</a>.<a href="../../../../../net/http/index.html#Request">Request</a>, cli *<a href="../../matrix/index.html">matrix</a>.<a href="../../matrix/index.html#Client">Client</a>)</pre>
<p>
OnReceiveWebhook receives requests from Travis-CI and possibly sends requests to Matrix as a result.
</p>
<p>
If the repository matches a known Github repository, a notification will be formed from the
template for that repository and a notice will be sent to Matrix.
</p>
<p>
Go-NEB cannot register with Travis-CI for webhooks automatically. The user must manually add the
webhook endpoint URL to their .travis.yml file:
</p>
<pre>notifications:
webhooks: <a href="http://go-neb-endpoint.com/notifications">http://go-neb-endpoint.com/notifications</a>
</pre>
<p>
See <a href="https://docs.travis-ci.com/user/notifications#Webhook-notifications">https://docs.travis-ci.com/user/notifications#Webhook-notifications</a> for more information.
</p>
<h3 id="Service.PostRegister">func (*Service) <a href="http://localhost:6060/src/github.com/matrix-org/go-neb/services/travisci/travisci.go?s=9069:9125#L249">PostRegister</a></h3>
<pre>func (s *<a href="index.html#Service">Service</a>) PostRegister(oldService <a href="../../types/index.html">types</a>.<a href="../../types/index.html#Service">Service</a>)</pre>
<p>
PostRegister deletes this service if there are no registered repos.
</p>
<h3 id="Service.Register">func (*Service) <a href="http://localhost:6060/src/github.com/matrix-org/go-neb/services/travisci/travisci.go?s=8601:8682#L234">Register</a></h3>
<pre>func (s *<a href="index.html#Service">Service</a>) Register(oldService <a href="../../types/index.html">types</a>.<a href="../../types/index.html#Service">Service</a>, client *<a href="../../matrix/index.html">matrix</a>.<a href="../../matrix/index.html#Client">Client</a>) <a href="../../../../../builtin/index.html#error">error</a></pre>
<p>
Register makes sure the Config information supplied is valid.
</p>
<div id="footer">
Build version go1.6.<br>
Except as <a href="https://developers.google.com/site-policies#restrictions">noted</a>,
the content of this page is licensed under the
Creative Commons Attribution 3.0 License,
and code is licensed under a <a href="http://localhost:6060/LICENSE">BSD license</a>.<br>
<a href="http://localhost:6060/doc/tos.html">Terms of Service</a> |
<a href="http://www.google.com/intl/en/policies/privacy/">Privacy Policy</a>
</div>
</div><!-- .container -->
</div><!-- #page -->
<!-- TODO(adonovan): load these from <head> using "defer" attribute? -->
<script type="text/javascript" src="../../../../../../lib/godoc/jquery.js"></script>
<script type="text/javascript" src="../../../../../../lib/godoc/jquery.treeview.js"></script>
<script type="text/javascript" src="../../../../../../lib/godoc/jquery.treeview.edit.js"></script>
<script type="text/javascript" src="../../../../../../lib/godoc/godocs.js"></script>
</body>
</html>

11
pkg/github.com/matrix-org/index.html

@ -361,6 +361,17 @@
<tr>
<td class="pkg-name" style="padding-left: 40px;">
<a href="go-neb/services/travisci/index.html">travisci</a>
</td>
<td class="pkg-synopsis">
Package travisci implements a Service capable of processing webhooks from Travis-CI.
</td>
</tr>
<tr> <tr>
<td class="pkg-name" style="padding-left: 20px;"> <td class="pkg-name" style="padding-left: 20px;">
<a href="go-neb/types/index.html">types</a> <a href="go-neb/types/index.html">types</a>

Loading…
Cancel
Save