notes

Documentation

Index

• func EnsureUser(ctx diag.Context) error
• func Fetch(ctx diag.Context, r RemoteRef) error
• func Load(ctx diag.Context, r RemoteRef, commit string, data any) error
• func Push(ctx diag.Context, r RemoteRef) error
• func Store(ctx diag.Context, r RemoteRef, data any) error
• type RemoteRef

Functions

func EnsureUser

func EnsureUser(ctx diag.Context) error

EnsureUser copies the user name and email from the head commit, if necessary. Calling Store in a GitHub action is likely to require this.

func Fetch

func Fetch(ctx diag.Context, r RemoteRef) error

Fetch copies notes from r to the local repo

func Load

func Load(ctx diag.Context, r RemoteRef, commit string, data any) error

Load attempts to retrieve notes from commit into data, copying or decoding as JSON.

func Push

func Push(ctx diag.Context, r RemoteRef) error

Push copies notes from the local repo to r

func Store

func Store(ctx diag.Context, r RemoteRef, data any) error

Store saves data against the head commit, copying it or encoding as JSON. Note that copied data should be clear next, but this is not enforced here.

Types

type RemoteRef

type RemoteRef struct {
	Remote string
	Ref    string
}