ruby

Documentation

Overview

Package ruby is the build planner for Ruby projects.

Index

• Constants
• func DetermineBuildCmd(framework types.RubyFramework, config plan.ImmutableProjectConfiguration) string
• func DetermineRubyFramework(source afero.Fs) types.RubyFramework
• func DetermineRubyVersion(source afero.Fs, config plan.ImmutableProjectConfiguration) string
• func DetermineStartCmd(framework types.RubyFramework, config plan.ImmutableProjectConfiguration) string
• func GenerateDockerfile(meta types.PlanMeta) (string, error)
• func NewIdentifier() plan.Identifier
• func NewPacker() packer.Packer

Constants

const (
	// ConfigRubyVersion is the configuration key for the Ruby version.
	ConfigRubyVersion = "ruby.version"
	// ConfigRubyEntry is the configuration key for the Ruby entrypoint file.
	//
	// When this configuration is set, the start command will be `ruby <entrypoint>`.
	ConfigRubyEntry = "ruby.entry"
)

const DefaultRubyEntrypoint = "main.rb"

DefaultRubyEntrypoint is the default entrypoint of Ruby projects.

const DefaultRubyVersion = "3.3"

DefaultRubyVersion is the default Ruby version of Zeabur.

Functions

func DetermineBuildCmd

func DetermineBuildCmd(framework types.RubyFramework, config plan.ImmutableProjectConfiguration) string

DetermineBuildCmd determines the build command of the Ruby project.

func DetermineRubyFramework

func DetermineRubyFramework(source afero.Fs) types.RubyFramework

DetermineRubyFramework determines the framework of the Ruby project.

func DetermineRubyVersion

func DetermineRubyVersion(source afero.Fs, config plan.ImmutableProjectConfiguration) string

DetermineRubyVersion determines the version of Ruby used in the project.

func DetermineStartCmd

func DetermineStartCmd(framework types.RubyFramework, config plan.ImmutableProjectConfiguration) string

DetermineStartCmd determines the start command of the Ruby project.

func GenerateDockerfile

func GenerateDockerfile(meta types.PlanMeta) (string, error)

GenerateDockerfile generates the Dockerfile for Ruby projects.

func NewIdentifier

func NewIdentifier() plan.Identifier

NewIdentifier returns a new Ruby identifier.

func NewPacker

func NewPacker() packer.Packer

NewPacker returns a new Ruby packer.