artifactcache

Documentation

Overview

Package artifactcache provides a cache handler for the runner.

Inspired by https://github.com/sp-ricard-valverde/github-act-cache-server

TODO: Authorization TODO: Restrictions for accessing a cache, see https://docs.github.com/en/actions/using-workflows/caching-dependencies-to-speed-up-workflows#restrictions-for-accessing-a-cache TODO: Force deleting cache entries, see https://docs.github.com/en/actions/using-workflows/caching-dependencies-to-speed-up-workflows#force-deleting-cache-entries

Index

• type Cache
  • func (c *Cache) FillKeyVersionHash()
• type Handler
  • func StartHandler(dir, outboundIP string, port uint16, logger logrus.FieldLogger) (*Handler, error)
  • func (h *Handler) Close() error
  • func (h *Handler) ExternalURL() string
• type Request
  • func (c *Request) ToCache() *Cache
• type Storage
  • func NewStorage(rootDir string) (*Storage, error)
  • func (s *Storage) Commit(id uint64, size int64) (int64, error)
  • func (s *Storage) Exist(id uint64) (bool, error)
  • func (s *Storage) Remove(id uint64)
  • func (s *Storage) Serve(w http.ResponseWriter, r *http.Request, id uint64)
  • func (s *Storage) Write(id uint64, offset int64, reader io.Reader) error

Types

type Cache

type Cache struct {
	ID             uint64 `json:"id" boltholdKey:"ID"`
	Key            string `json:"key" boltholdIndex:"Key"`
	Version        string `json:"version" boltholdIndex:"Version"`
	KeyVersionHash string `json:"keyVersionHash" boltholdUnique:"KeyVersionHash"`
	Size           int64  `json:"cacheSize"`
	Complete       bool   `json:"complete"`
	UsedAt         int64  `json:"usedAt" boltholdIndex:"UsedAt"`
	CreatedAt      int64  `json:"createdAt" boltholdIndex:"CreatedAt"`
}

func (*Cache) FillKeyVersionHash

func (c *Cache) FillKeyVersionHash()

type Handler

type Handler struct {
	// contains filtered or unexported fields
}

func StartHandler

func StartHandler(dir, outboundIP string, port uint16, logger logrus.FieldLogger) (*Handler, error)

func (*Handler) Close

func (h *Handler) Close() error

func (*Handler) ExternalURL

func (h *Handler) ExternalURL() string

type Request

type Request struct {
	Key     string `json:"key" `
	Version string `json:"version"`
	Size    int64  `json:"cacheSize"`
}

func (*Request) ToCache

func (c *Request) ToCache() *Cache

type Storage

type Storage struct {
	// contains filtered or unexported fields
}

func NewStorage

func NewStorage(rootDir string) (*Storage, error)

func (*Storage) Commit

func (s *Storage) Commit(id uint64, size int64) (int64, error)

func (*Storage) Exist

func (s *Storage) Exist(id uint64) (bool, error)

func (*Storage) Remove

func (s *Storage) Remove(id uint64)

func (*Storage) Serve

func (s *Storage) Serve(w http.ResponseWriter, r *http.Request, id uint64)

func (*Storage) Write

func (s *Storage) Write(id uint64, offset int64, reader io.Reader) error