Browse Source

docs: package documentation

master
Stefan Naumann 3 months ago
parent
commit
a86c7297a7
  1. 1
      auth/base.go
  2. 3
      build/build.go
  3. 4
      build/worker.go
  4. 2
      hook/hook.go
  5. 13
      main.go

1
auth/base.go

@ -24,7 +24,6 @@
// A module can either:
// * generate a secret on enabling, if no user interaction is required
// * generate a secret, request the user to interact with the module, e.g. type in the first TOTP code, then commit its secret and enable itself
package auth
import (

3
build/build.go

@ -1,6 +1,3 @@
// package build contains some helper functions called by the web-package to
// create a new build, rebuilding a finished (or failed) one and enqueuing them
// into the build queue (channel)
package build
import (

4
build/worker.go

@ -1,10 +1,10 @@
// package build
// There are n build workers, which are started at the start of mvoCI.
// They execute BuildWorker. When a new build object is spawned into the
// build queue / channel, it is fetched (from git repo), the buildscript
// is placed in the folder and executed with bash. Then the directory
// is zipped and later removed.
//
// Two builds cannot be ongoing on the same repo at the same time.
package build
import (

2
hook/hook.go

@ -1,3 +1,5 @@
// The hook package contains code for the build hoops of the different
// source code versioning systems, like gitea, gogs, gitlab, etc.
package hook
import (

13
main.go

@ -1,5 +1,14 @@
// entry point of mvoCI
// currently mvoCI uses gorm as the Database ORM, and echo as the webserver.
// mvoCI is a simple continuous integration server aimed at personal use.
// You really should not use it as an open CI server and only provide it to
// people and code you trust. mvoCI does not isolate build-processes well, if
// you need that, please choose a different solution.
//
// mvoCI aims to be simple and easy to use, not a lot of features, just enough
// to build simple projects and maybe deploy them to your server fo example.
// It is not equipped with distributed building atm (while you of course could
// script that in the build script).
//
// Be aware, mvoCI lets you shoot of your foot. Don't.
package main
import (

Loading…
Cancel
Save