Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Include documentation on the creation of hooks in the ReadMe #295

Closed
Jack-Collins opened this issue Feb 26, 2016 · 6 comments
Closed

Include documentation on the creation of hooks in the ReadMe #295

Jack-Collins opened this issue Feb 26, 2016 · 6 comments

Comments

@Jack-Collins
Copy link

Sorry if this is the wrong place - I have been trying to set up a Travis hook via the github api using this library but can not find any documentation on this in the readme, or anywhere else. If somebody knows how to do it, it would be a great addition to this repo's readme I think.

@AurelioDeRosa
Copy link
Member

You can start here but for sure this is something we should document.

@clayreimann
Copy link
Member

Should add https://tonicdev.com/clayreimann/5722a004b9583b1100c8adf3 to the documentation

@Jack-Collins
Copy link
Author

var options = {
            "name" : "travis",
        "config" : {
                    "user" : "your-Username",
                    "token" : "00000000000000000000000000",
                    "domain" : "http://notify.travis-ci.org",
                    "content_type": "json"
                    },
        "events" : ["push", "pull_request"],
        "active" : true
        }
        //create the git-travis hook
        try{
            fork.createHook(options, function(){
                console.log("A travis hook has been created which will trigger a build on push and pull request events...");
            });
        }
        catch(err){
             console.log(err);
        }

@Jack-Collins
Copy link
Author

I successfully created a travis hook using the above. Wasn't sure where to document it...

@clayreimann
Copy link
Member

@Jack-Collins the best place to document it would be to add an example in the gh-pages branch.

@Jack-Collins
Copy link
Author

pr here: #336

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants