Giter Site home page Giter Site logo

revisioneer / revisioneer Goto Github PK

View Code? Open in Web Editor NEW
2.0 2.0 2.0 109 KB

create deployment timelines - api written in golang

Home Page: http://blog.nicolai86.eu

License: MIT License

Makefile 6.12% Go 90.73% TSQL 3.15%
golang deployment-timelines deployments timelines

revisioneer's Introduction

revisioneer

Build Status

create deployment timelines to communicate changes to your clients. revisioneer is a backend written in Go which sole purpose is to store your deployments & changeset messages you want to communicate.

You can retrieve those informations at any time, but how you display them is entirely up to you.

The service has only a single dependency on a database, which you can provision any way you like.

Tests

To run the testsuite you need to have a PostgreSQL server running & deployed. Revisioneer migrates the database schema automatically, so you only need to create a database.

createdb revisioneer_test

REV_DSN="user=$(whoami) dbname=revisioneer_test sslmode=disable" go test

Executing

createdb revisioneer

REV_DSN="user=$(whoami) dbname=revisioneer sslmode=disable" ./revisioneer

API Examples

Create a project

curl -X POST "http://127.0.0.1:8080/projects" -d '{ "name": "test" }'
# => 200 OK
{
   "name": "test",
   "api_token": "q+fehEVx5Kxast2DdUUnKaQpNiZ4GTsmmaYerNwDXDE=",
   "created_at": "2013-11-14T22:48:54.431707172+01:00"
}

Make sure to keep the api_token around. There is currently no way to retrieve it.

Create a new deployment information

curl -X POST "http://127.0.0.1:8080/deployments" \
  -d '{ "sha": "61722b0020", "messages": ["* added support for messages"], "new_commit_counter": 1 }' \
  -H "API-TOKEN: q+fehEVx5Kxast2DdUUnKaQpNiZ4GTsmmaYerNwDXDE="
# => 200 OK

Verify a deployment

curl -X POST "http://127.0.0.1:8080/deployments/61722b0020/verify" \
  -H "API-TOKEN: q+fehEVx5Kxast2DdUUnKaQpNiZ4GTsmmaYerNwDXDE="
# => 200 OK

Read all deployments

curl "http://localhost:8080/deployments" \
  -H "API-TOKEN: q+fehEVx5Kxast2DdUUnKaQpNiZ4GTsmmaYerNwDXDE="
# => 200 OK
[
    {
        "sha": "61722b0020",
        "deployed_at": "2013-11-14T22:52:40.746848+01:00",
        "messages": [
            "* added support for messages"
        ]
    }
]

Returns only the most recent 20 deployments. You can adjust this using page and limit parameters.

revisioneer's People

Contributors

mitch000001 avatar nicolai86 avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar

revisioneer's Issues

add webhook notification support

I'd like to have the ability to notify other services of new releases, e.g. posting to slackbase or clearing bugs in airbreak.

W'd need support for webhooks to achieve that.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.