Documentation
¶
Index ¶
Constants ¶
View Source
const ( // DefaultAssignmentRegex is the default regex pattern for assignment folders with named groups DefaultAssignmentRegex = `^(?P<branch>assignment-\d+)$` // DefaultBranch is the default branch name for pull requests DefaultBranch = "main" // DefaultDryRun is the default dry-run mode setting DefaultDryRun = "false" // ActionName is the name used to identify this action in workflows ActionName = "assignment-pull-request" )
Default configuration values for the Assignment Pull Request Creator
View Source
const ( // EnvGitHubToken is the environment variable for GitHub token EnvGitHubToken = "GITHUB_TOKEN" // EnvGitHubRepository is the environment variable for repository name EnvGitHubRepository = "GITHUB_REPOSITORY" // EnvAssignmentRegex is the environment variable for assignment regex patterns EnvAssignmentRegex = "ASSIGNMENT_REGEX" // EnvDefaultBranch is the environment variable for default branch name EnvDefaultBranch = "DEFAULT_BRANCH" // EnvDryRun is the environment variable for dry-run mode EnvDryRun = "DRY_RUN" )
Environment variable names
View Source
const ( // GitHubActionsWorkflowDir is the directory containing GitHub Actions workflows GitHubActionsWorkflowDir = ".github/workflows" // GitHubWorkflowTemplatesDir is the directory containing GitHub workflow templates GitHubWorkflowTemplatesDir = ".github/workflow-templates" // SparseCheckoutFile is the path to git sparse-checkout configuration SparseCheckoutFile = ".git/info/sparse-checkout" // ReadmeFileName is the standard README file name ReadmeFileName = "README.md" // ReadmeFileName is the standard README file name ReadmeFileNameLowerCase = "readme.md" )
Common patterns and values
View Source
const ( // YamlExtension is the YAML file extension YamlExtension = ".yml" // YamlAltExtension is the alternative YAML file extension YamlAltExtension = ".yaml" // MarkdownExtension is the Markdown file extension MarkdownExtension = ".md" )
File extensions and patterns
View Source
const (
// WorkflowAssignmentRegexKey is the YAML key for assignment regex patterns
WorkflowAssignmentRegexKey = "assignment-regex"
)
Workflow file YAML keys
Variables ¶
View Source
var FilteredFolders = []string{".git", ".github", ".devcontainer"}
Repository folders to filter out from sparse-checkout
Functions ¶
This section is empty.
Types ¶
This section is empty.
Click to show internal directories.
Click to hide internal directories.