Categorygithub.com/urethramancer/triggerwarning
modulepackage
0.3.1
Repository: https://github.com/urethramancer/triggerwarning.git
Documentation: pkg.go.dev
Overview
Versions
1
Dependencies
31
Dependents
0
Files
1k SLOC

# README

Trigger Warning Build Status

Pull Git repositories and notify watchers on trigger.

Who or what is this for?

This is an internal utility I use to keep repositories up to date on a server whenever I check in elsewhere.

Requirements

  • github.com/Urethramancer/cross
  • github.com/Urethramancer/slog
  • github.com/fsnotify/fsnotify
  • github.com/gorilla/mux
  • github.com/jessevdk/go-flags
  • golang.org/x/crypto/sha3
  • golang.org/x/crypto/ssh
  • gopkg.in/src-d/go-git.v4
  • gopkg.in/src-d/go-git.v4/plumbing/transport/ssh

These should be fetched automatically.

Status

Currently it runs as a web server and accepts HTTP or HTTPS requests to the /trigger endpoint, which takes a nameparameter to select a repository to update (either internal pull or external command git pull).

Features

Currently users can be added and trigger pulls.

Unimplemented features

  • Add users as watchers of specific repositories.
  • Notify watchers.

Licence

MIT.

# Functions

Handle walks through its chain of middleware for a web request.
LoadJSON loads a JSON file into a structure.
SaveJSON writes any structure to file as JSON.

# Constants

PathTrigger requires 'name', 'user' and 'token' parameters.
PathUnwatch requires 'name', 'user' and 'token' parameters.
PathWatch requires 'name', 'user' and 'token' parameters.
StatusAuthFailed means username or password was wrong, or account non-existent.
StatusError is for generic error messages.
StatusNoAccess means the token given does not have access to the requested data.
StatusNoAuth means no or wrong auth token was passed.
StatusNoCredentials means wrong inputs to login.
StatusOK means no problems.

# Variables

Channels are used all over the program.
Version is injected via build flags from git tags.

# Structs

AddCmd arguments.
AddTrigger arguments.
AddUser arguments.
AddWatcher arguments.
Config is used to parse the main configuration file.
ListCmd arguments.
Logs hold the names of log files to output to.
Result is returned from many JSON requests.
Security defines password security level and many SSL settings.
ServerCmd arguments.
SSH options for authentication.
Trigger holds details for a Git repository to update when triggered.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Web defines addresses, ports and domains to route.

# Type aliases

No description provided by the author