4 Commits

4 changed files with 283 additions and 17 deletions

View File

@@ -2,4 +2,18 @@
## Intro
blah blah blah
## Git
Git is available to be used as the version control system for new projects. Select/Deselect within the `scaffold-<PROJECTTYPE>.toml` file.
***Please Note** that if you also use it for your configuration files and sample directories, then a .gitignore file within your sample directory will interfere with git's ability to track your skeletons/templates properly. So, to allow for this, put what you normally would in a .gitignore file into a GITIGNORE file in your sample directory. And scaffold will convert it to a .gitignore file within your newProject directory.
If you are NOT using git to track your project types and samples/skeletons/templates, then no problem, just place a .gitignore file within the sample directory as you would any other file.
## The Process
- The new project directory is created
- Your project skeleton is copied from your sample directory
- your setup/initialization commmands are run
- a git repository is initialized in the project directory
- and if you enable it, a remote repository is created and setup

View File

@@ -10,3 +10,90 @@ Usage examples:
scaffold go NewGoProject
scaffold py aPythonProject
`
// var gi_template = `%s
// .env
// *.env
// .env.toml
// cfg/*.toml
// cfg/.env
// cfg/*.env
// cfg/.env*
// *.toml
// build/
// buildTime.txt
// buildVersion.txt
// `
// var gi_py_template = `%s
// .env
// *.env
// .env.toml
// cfg/*.toml
// cfg/.env
// cfg/*.env
// cfg/.env*
// *.toml
// bin/
// `
// var cfg_content = `# New Go Project configuration file
// # Format: TOML - see https://toml.io for details
// # Go specific
// # Go module path is of the form basePath/projectName
// # must be addressable if you are going to publish
// module_basepath = "officallygood.com"
// # where to put new project directories
// # within the user's home directory
// projects_basedir = "devel/GoMyApps"
// #def_project_name = "new-go-project"
// # Must be string, will be parsed to correct type
// # Remember perms are in octal
// project_dir_permissions = "0700"
// file_permissions = "0660"
// # 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 = false
// # remote repo user@location
// remote_user = "user@server"
// # remote repo base dir
// # relative to remote user home dir
// # eg unix/linux server
// # for user@server:/home/user/git -- absolute path
// user@server:git -- relative to home dir
// # eg windows server
// # ???
// ############################
// # remote location MUST already exist on remote server
// ############################
// remote_location = "git"
// # default remote short name
// remote_shortname = "origin"
//`
var cfg_content = `# Scaffold program configuration
# Format: TOML - see https://toml.io for details
# Too funny - this config file doesn't seem to be needed ;-)
# let's keep it for future use -- very silly
testkey = "test value"`

View File

@@ -0,0 +1,106 @@
# 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"

89
main.go
View File

@@ -30,7 +30,13 @@ type (
Create_Remote_Repo bool
Remote_User string
Remote_Location string
Remote_Shortname string
Remote_Label string
Commands [][]string
Setup_gitea bool
Gitea_server_account string // should be in ~/.ssh/config
Gitea_ssh_host_label string
Gitea_user_account string
Remote_Label_gitea string
}
ScaffoldSetup struct {
TestKey string
@@ -71,13 +77,20 @@ func main() {
if _, err := os.Stat(cfg_file); err != nil {
fmt.Println("No scaffold program configuration file found - creating a default file")
// ok now do it
cfgfd, err := os.Create(cfg_file)
ifFerr("Unable to create scaffold configuration file", err)
defer cfgfd.Close()
_, err = cfgfd.WriteString(cfg_content)
ifFerr("Unable to write scaffold configuration file content", err)
fmt.Println("Wrote new scaffold configuration file")
_, err = toml.Decode(cfg_content, &setup)
ifFerr("[Failed] to parse config file", err)
} else {
fmt.Println("found config file")
}
_, err = toml.DecodeFile(cfg_file, &setup)
ifFerr("[Failed] to parse config file", err)
}
pts, err := availableProjectTypes(scaffold_cfg_dir)
ifFerr("Unable to read scaffold config directory contents", err)
@@ -106,6 +119,8 @@ func main() {
_, err = toml.DecodeFile(projectCfgFile, &npsetup)
ifFerr("Unable to read configuration for requested project type", err)
//fmt.Printf("Found commands: %+v\n", npsetup.Commands)
//Setup and Ready to begin
// Permissions are octal (ugo - user, group, other)
@@ -158,17 +173,21 @@ func main() {
}
fmt.Println("Project sample skeleton copied")
// run init commands
// run your init commands from the projectType/scaffold-<PROJECTTYPE>.toml file
// make mod file
modpath := npsetup.Module_basepath + sep + newProjectName
_, err = exec.Command("go", "mod", "init", modpath).Output()
ifFerr("go mod init failed", err)
// do a mod tidy to update the mod file
_, err = exec.Command("go", "mod", "tidy").Output()
ifFerr("Unable to update the mod file with a tidy", err)
fmt.Println("Updated go.mod")
for _, comm := range npsetup.Commands {
args := comm[1:]
if comm[0] == "go" && comm[1] == "mod" && comm[2] == "init" {
args[2] = args[2] + sep + newProjectName
//fmt.Printf("executing: %+v -- %+v\n", comm, args)
}
_, err = exec.Command(comm[0], args...).Output()
if err != nil {
commstring := fmt.Sprintf("Unable to execute command: %+v", comm)
log.Fatalf("%s -- %s\n", commstring, err)
}
fmt.Printf("executing: %+v %+v\n", comm[0], args)
}
// setup git
if npsetup.Setup_git {
@@ -176,6 +195,33 @@ func main() {
_, err = exec.Command("git", "init").Output()
ifFerr("Unable to initialize git repository", err)
nifd, err := os.Create(".gitignore")
ifFerr("Unable to create .gitignore file", err)
defer nifd.Close()
var gi_content string
var gi_in []byte = []byte("bin/")
gisrc, err := os.Open("GITIGNORE")
if err == nil { // assume error means there is no source file
gi_in, err = io.ReadAll(gisrc)
if err != nil {
fmt.Println("Unable to read GITIGNORE, using default content")
}
gi_content = fmt.Sprintf("%s\n\n%s", newProjectName, string(gi_in))
_, err = nifd.WriteString(gi_content)
ifFerr("Unable to write .gitignore content", err)
fmt.Println("Wrote .gitignore content")
// remove GITIGNORE
err = os.Remove("GITIGNORE")
if err != nil {
fmt.Println("Unable to remove GITIGNORE file")
}
}
defer gisrc.Close()
// stage files
_, err = exec.Command("git", "add", ".").Output()
ifFerr("Unable to stage files prior to first commit", err)
@@ -194,7 +240,7 @@ func main() {
// add remote to local repo
new_remote_repo := npsetup.Remote_User + ":" + npsetup.Remote_Location + "/" + newProjectName + ".git"
_, err = exec.Command("git", "remote", "add", npsetup.Remote_Shortname, new_remote_repo).Output()
_, err = exec.Command("git", "remote", "add", npsetup.Remote_Label, new_remote_repo).Output()
ifFerr("Unable to set git remote for new repo", err)
fmt.Println("Added remote repo to git as origin")
@@ -206,6 +252,19 @@ func main() {
fmt.Println("Pushed initial commit to remote")
}
if npsetup.Setup_gitea {
// create gitea repo
grcomm := fmt.Sprintf("%s:%s/%s.git", npsetup.Gitea_ssh_host_label, npsetup.Gitea_user_account, newProjectName)
_, err = exec.Command("git", "remote", "add", npsetup.Remote_Label_gitea, grcomm).Output()
ifFerr("Unable to set git remote for new project to gitea", err)
fmt.Println("Added remote repo to git for gitea as ", npsetup.Remote_Label_gitea)
// -u sets upstream tracking
_, err = exec.Command("git", "push", "-u", npsetup.Remote_Label_gitea, "main").Output()
ifFerr("Unable to push new project to gitea", err)
fmt.Println("Pushed new project to gitea")
}
}
fmt.Printf("New %s Project: %s ready\n", projType, newProjectName)