objects

package
v0.0.0-...-b354f97 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 18, 2023 License: AGPL-3.0 Imports: 4 Imported by: 0

Documentation

Overview

Package objects provides the base objects used in SWLCS.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Comment

type Comment struct {
	// Resource is the unique identifier of the blog post or page the comment refers to
	Resource string
	// AuthorName is the name of the author of the comment
	AuthorName string
	// AuthorEmail is the email of the author of the comment
	AuthorEmail string
	// Body is the text of the comment
	Body string
	// Time is the date/time the comment was created
	Time time.Time
}

Comment is the structure that contains a comment.

func (Comment) FileContent

func (c Comment) FileContent() ([]byte, error)

FileContent returns the comment in YAML format

func (Comment) FileName

func (c Comment) FileName() string

FileName returns the name that the file will need to have to properly read by the rendering function

type Repository

type Repository struct {
	// GitHubClient is the reference to a GitHub client instance
	GitHubClient *github.Client
	// Owner is the name of the repository Owner on GitHub
	Owner string
	// Name is the name of the repository on GitHub
	Name string
	// Branch is the name of the branch that contains the website
	Branch string
}

Repository is the structure that contains the information of the GitHub repository where the website is hosted

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL