Files
scaffold/examples/example_scaffold-go.toml
2023-04-13 15:13:38 -04:00

107 lines
3.2 KiB
TOML

# New Go Project configuration file
# Format: TOML - see https://toml.io for details
# Go module path is of the form basePath/projectName
# must be addressable if you are going to publish
module_basepath = "somewhere.org"
# where to put new project directories
# within the user's home directory
projects_basedir = "projects/goapps"
# go example dirs
# /cmd, /pkg, /web, /api, /init, /vendor, /internal, /bin, /build,
# /cfg, /configs, /docs, /scripts, /tools, /examples, /tests,
# /deployments, /deploy
# or whatever you like
# Must be string, will be parsed to correct type
# Remember perms are in octal
project_dir_permissions = "0700"
file_permissions = "0660"
###########################################
# Commands to run
###########################################
# after the newProjectDir is created and
# after the sample dir contents are copied over
### before git is initialized (local and remote)
# For the command: go mod init full_module_name -- use the your module_basename
# scaffold will add "/newProjectName" to it automatically
# so ["go", "mod", "init", "modulebase.net"] becomes ==> ["go", "mod", "init", "modulebase.net/NewPojectName"]
commands = [["go", "mod", "init", "somewhere.org"], ["go", "mod", "tidy"]]
##########################################
# Git
setup_git = true
# Do you have a remote location?
# Do you have autologins setup correctly with ssh keys?
# Using your .ssh/config file might be helpful
# setup remote repo?
create_remote_repo = true
# remote repo user@location
remote_user = "auser@someserver.adomain.org"
# remote repo base dir
# relative to remote user home dir
# for auser@someserver.adomain.org:/home/auser/git -- lists git dir as absolute path
# for auser@someserver.adomain.org:git -- lists git dir as relative path
############################
# remote location MUST already exist on remote server
############################
remote_location = "gitdirectory/goprojects"
# default remote short name
remote_label = "origin"
# Gitea -- do you use it somewhere
############################
# Does the Gitea app.ini have
#
# [repository]
# ENABLE_PUSH_CREATE_USER = true
# ENABLE_PUSH_CREATE_ORG = true
#
# it's needed for scaffold to push to gitea
############################
############################
#
# 4 pieces of info are needed
# 1) the server domain name eg gitea.adomain.org
# 2) the ssh port if it's not the default 22
# 3) the server account that clients connect to for ssh
# sometimes it's git or gitea or gitadmin or
# 4) the gitea user account username
# (if your gitea account is mrspecial then it's mrspecial)
#
# items 1, 2 and 3 should be in a Host section in your .ssh/config file
#
# In a section like
# Host gitea
# Hostname gitea.adomain.org
# User serveraccount
# Port 22222
# IdentitiesOnly yes
# PreferredAuthentications publickey
# IdentityFile ~/.ssh/your_id_file_private
#
# Then scaffold will set a git remote for gitea with:
#
# git remote add <gitea_remote_label> <host>:<gitea_user_accountname>/<newprojectname>.git
#
############################
setup_gitea = true
gitea_server_account = "gitea-account"
gitea_ssh_host_label = "gitea"
gitea_user_account = "auser"
remote_label_gitea = "gitea"