cite

README

cite-codeberg

cite-codeberg is a simple Go package to ease citing code hosted on Codeberg.

Installation

$> go install codeberg.org/sbinet/cite-codeberg@latest
$> go install codeberg.org/sbinet/cite-codeberg/cmd/zenodo-release@latest

Example

$> zenodo-release -h
zenodo-release publishes a release from Forgejo/Codeberg to Zenodo.

Usage: zenodo-release [OPTIONS] [RELEASE-TAG]

Example:

 $> zenodo-release -auth=s3cr3t-t0k3n v0.1.0
 $> zenodo-release -auth=s3cr3t-t0k3n latest
 $> zenodo-release -auth=s3cr3t-t0k3n
 $> zenodo-release -auth=s3cr3t-t0k3n -doi=10.5281/zenodo.18851470 -repo=sbinet/cite-codeberg

Options:
  -auth string
    	Zenodo authentication token
  -doi string
    	Concept DOI number for the repository (default "10.5281/zenodo.18851470")
  -forgejo-endpoint string
    	Forgejo endpoint (default "https://codeberg.org")
  -repo string
    	repository name (default "sbinet/cite-codeberg")
  -zenodo-endpoint string
    	Zenodo endpoint (default "https://zenodo.org")

$> zenodo-release -repo=my/repo -doi=10.5072/zenodo.414542 -auth=s3cr3t-t0ken
zenodo-release: new-id:  18851299
zenodo-release: doi:     "10.5072/zenodo.6664242"
zenodo-release: concept: "10.5072/zenodo.414542"
zenodo-release: title:   my/repo: Release v0.42.0

Documentation

Overview

Package cite holds tools and types to ease citing software hosted on Codeberg.

Index

• type Repository
  • func Repo(fullname string) (rep Repository, err error)
  • func (r Repository) FullName() string
  • func (r Repository) Release(cli *forgejo.Client, tag string) (*forgejo.Release, error)

Types

type Repository

type Repository struct {
	Owner string // owner of this repository, eg: "sbinet"
	Name  string // name of this repository, eg: "cite-codeberg"
}

Repository models a forgejo repository.

func Repo

func Repo(fullname string) (rep Repository, err error)

Repo creates a forgejo repository handle using its fullname.

Example:

rep, err := cite.Repo("sbinet/cite-codeberg")

func (Repository) FullName

func (r Repository) FullName() string

FullName returns the fully qualified name of this repository. ie: "sbinet/cite-codeberg".

func (Repository) Release

func (r Repository) Release(cli *forgejo.Client, tag string) (*forgejo.Release, error)

Release returns the forgejo release with the provided tag name, from the provided forgejo client.

If tag is empty or "latest", the latest release from forgejo is searched for.