giteaops

giteaops

Description

This package contains all of the gitea API calls to manage organizations, repositories and branches on a gitea server (gitea, not git) :

• Organizations: Create, Delete, List
• Repositories: Create, Delete, Transfer ownership, Clone, List
• Branches: Create, Delete
• Users: Create, Delete, List, Get User info, Generate Auth token, Change Passwd

A note about cloning repos :

There is no API calls to clone a gitea repo, therefore we rely on the git command to do so.

Installing the package

Pretty simple, as with most GO packages : go get github.com/jeanfrancoisgratton/giteaops from the same directory that you find go.mod

Usage

Pre-requisites

You must have a valid gitea auth token on the remote gitea server. As most of the API calls require admin privileges, create your token accordingly.

Package initialization

First, your client software must initialize the package with a command such as:

import (
	"github.com/jeanfrancoisgratton/giteaops"
    cerr "github.com/jeanfrancoisgratton/customError"
)

func InitManager (serverURL, authToken string) *cerr.CustomError {
    gm, err := giteaops.NewGiteaManager(serverURL, authToken)
    if err != nil {
        return &cerr.CustomError{Title: "Failed to create Gitea manager", Message: err.Error()}
    } else {
		return gm, nil
}

The two return values are thus:

• gm: *GiteaManager, the entry point to the giteaops package
• err: *cerr.CustomError, my custom wrapper around error (more on that later)

Example of operation: delete a repository

Let's put a working example where we initialize the GiteaManager and use it to call gitea's API and delete a repository

import (
	"github.com/jeanfrancoisgratton/giteaops"
	cerr "github.com/jeanfrancoisgratton/customError"
	"os"
)

func giteaDispatcher() {
	baseURL := "https://mygiteaserver:1234"
	token := "some_token"
	owner := "my_org_or_username"
	repo := "my_repo"
	
	if err := deleteRepo (baseURL, token, owner, repo); err != nil {
		fmt.Println(err.Error())
		os.Exit(0)
    }
}

// Simple deleteRepo()
func deleteRepo(baseURL, token, owner, repo string) *cerr.CustomError {
    var gm *GiteaManager
	var err *cerr.CustomError
	
	// initialize the package's manager
	if gm, err = giteaops.NewGiteaManager(serverURL, authToken); err != nil {
        return &cerr.CustomError{Title: "Failed to create Gitea manager", Message: err.Error()}
    }
	
	// Delete the repository
	return gm.DeleteRepository(owner, repo)
}

The code is quite simple: I've provided dummy values for the required variables, and have shown how simple handling errors with CustomError is.