pkg

Documentation

Index

• Constants
• Variables
• type Ancestor
• type Markdown2Confluence
  • func (m *Markdown2Confluence) CreateClient()
  • func (m *Markdown2Confluence) DefaultRun() error
  • func (m *Markdown2Confluence) LoadConfig() error
  • func (m *Markdown2Confluence) LoadSingleConfig(fileName string) error
  • func (m *Markdown2Confluence) PrintMe()
  • func (m *Markdown2Confluence) Run() []error
  • func (m *Markdown2Confluence) RunAllConfigs() map[string]error
  • func (m *Markdown2Confluence) SourceEnvironmentVariables()
  • func (m Markdown2Confluence) Validate() error
• type MarkdownConverter
• type MarkdownFile
  • func (f *MarkdownFile) FindOrCreateAncestor(m *Markdown2Confluence, client *confluence.Client, ancestorID, parent string) (string, error)
  • func (f *MarkdownFile) FindOrCreateAncestors(m *Markdown2Confluence) (ancestorID string, err error)
  • func (f *MarkdownFile) FormattedPath() (s string)
  • func (f *MarkdownFile) String() (url string)
  • func (f *MarkdownFile) Upload(m *Markdown2Confluence) (url string, err error)

Constants

const (
	// DefaultEndpoint provides an example endpoint for users
	DefaultEndpoint = "https://mydomain.atlassian.net/wiki"

	// Parallelism determines how many files to convert and upload at a time
	Parallelism = 5
)

const DefaultConfigFile = `./.github/confluence.yml`

Variables

var ParentIndex = make(map[string]string)

ParentIndex caches parent page Ids for futures reference

Types

type Ancestor

type Ancestor struct {
	ID string `json:"id,omitempty"`
}

Ancestor TODO: move this to go-confluence api

type Markdown2Confluence

type Markdown2Confluence struct {
	Space          string              `json:"space"`
	Title          string              `json:"title"`
	File           string              `json:"file"`
	Ancestor       string              `json:"ancestor"`
	Debug          bool                `json:"debug"`
	Since          int                 `json:"since"`
	Username       string              `json:"username"`
	Password       string              `json:"password"`
	Endpoint       string              `json:"endpoint"`
	Parent         string              `json:"parent"`
	SourceMarkdown []string            `json:"source"` // TODO deprecate
	Sources        []MarkdownConverter `json:"sources"`

	LoadFromConfig *[]string `json:"parent_config"`
	DryRun         bool
	RunAllFiles    string
	// contains filtered or unexported fields
}

Markdown2Confluence stores the settings for each run

func (*Markdown2Confluence) CreateClient

func (m *Markdown2Confluence) CreateClient()

CreateClient returns a new markdown clietn

func (*Markdown2Confluence) DefaultRun

func (m *Markdown2Confluence) DefaultRun() error

func (*Markdown2Confluence) LoadConfig

func (m *Markdown2Confluence) LoadConfig() error

func (*Markdown2Confluence) LoadSingleConfig

func (m *Markdown2Confluence) LoadSingleConfig(fileName string) error

func (*Markdown2Confluence) PrintMe

func (m *Markdown2Confluence) PrintMe()

func (*Markdown2Confluence) Run

func (m *Markdown2Confluence) Run() []error

Run the sync

func (*Markdown2Confluence) RunAllConfigs

func (m *Markdown2Confluence) RunAllConfigs() map[string]error

func (*Markdown2Confluence) SourceEnvironmentVariables

func (m *Markdown2Confluence) SourceEnvironmentVariables()

SourceEnvironmentVariables overrides Markdown2Confluence with any environment variables that are set

• CONFLUENCE_USERNAME
• CONFLUENCE_PASSWORD
• CONFLUENCE_ENDPOINT

func (Markdown2Confluence) Validate

func (m Markdown2Confluence) Validate() error

Validate required configs are set

type MarkdownConverter

type MarkdownConverter struct {
	Parent         string `json:"parent"`
	SourceMarkdown string `json:"source"`
	Title          string `json:"title"`
}

type MarkdownFile

type MarkdownFile struct {
	Path     string
	Title    string
	Parents  []string
	Ancestor string
}

MarkdownFile contains information about the file to upload

func (*MarkdownFile) FindOrCreateAncestor

func (f *MarkdownFile) FindOrCreateAncestor(m *Markdown2Confluence, client *confluence.Client, ancestorID, parent string) (string, error)

FindOrCreateAncestor creates an empty page to represent a local "folder" name

func (*MarkdownFile) FindOrCreateAncestors

func (f *MarkdownFile) FindOrCreateAncestors(m *Markdown2Confluence) (ancestorID string, err error)

FindOrCreateAncestors creates an empty page to represent a local "folder" name

func (*MarkdownFile) FormattedPath

func (f *MarkdownFile) FormattedPath() (s string)

FormattedPath returns the Path with Parents

func (*MarkdownFile) String

func (f *MarkdownFile) String() (url string)

func (*MarkdownFile) Upload

func (f *MarkdownFile) Upload(m *Markdown2Confluence) (url string, err error)

Upload a markdown file