Compare commits
6 Commits
v0.1.3
...
e65633a85a
| Author | SHA1 | Date | |
|---|---|---|---|
| e65633a85a | |||
| d53ad8993c | |||
| 7b7fdc0113 | |||
| b010d63351 | |||
| c5447a68ae | |||
| 6c03f880da |
19
Makefile
19
Makefile
@@ -24,6 +24,8 @@ endif
|
|||||||
# Variables
|
# Variables
|
||||||
#----------------------------------------------------------------
|
#----------------------------------------------------------------
|
||||||
progName = scaffold
|
progName = scaffold
|
||||||
|
arch = amd64
|
||||||
|
winbinName = $(progName).exe
|
||||||
|
|
||||||
#----------------------------------------------------------------
|
#----------------------------------------------------------------
|
||||||
# Helpers
|
# Helpers
|
||||||
@@ -57,11 +59,18 @@ prep: clean
|
|||||||
> date +"%F %a %T %Z" > buildTime.txt
|
> date +"%F %a %T %Z" > buildTime.txt
|
||||||
> git describe --always --tags --dirty --long > buildVersion.txt
|
> git describe --always --tags --dirty --long > buildVersion.txt
|
||||||
|
|
||||||
build: prep
|
build: prep linux windows
|
||||||
> @go build -o build/$(progName) . && echo "Build success" || echo "[FAILED] go build"
|
|
||||||
|
|
||||||
build-production: prep
|
linux:
|
||||||
> @go build -ldflags=${linkerflags} -o build/$(progName) . && echo "production build success" || echo "[FAILED] production build"
|
> @GOOS=$@ GOARCH=$(arch) go build -o build/$@/$(progName) . && echo $@ "Build success" || echo $@ "[FAILED] go build"
|
||||||
|
|
||||||
|
windows:
|
||||||
|
> @GOOS=$@ GOARCH=$(arch) go build -o build/$@/$(winbinName) . && echo $@ "Build success" || echo $@ "[FAILED] go build"
|
||||||
|
|
||||||
|
build-production: prep linx-production
|
||||||
|
|
||||||
|
linux-production:
|
||||||
|
> @GOOS=linx GOARCH=$(arch) go build -ldflags=${linkerflags} -o build/$@/$(progName) . && echo "production build success" || echo "[FAILED] production build"
|
||||||
|
|
||||||
#-------------------------------------------------------------
|
#-------------------------------------------------------------
|
||||||
# Install - same as build, but places binary on system path
|
# Install - same as build, but places binary on system path
|
||||||
@@ -74,4 +83,4 @@ install-production: prep
|
|||||||
> @go install -ldflags=${linkerflags} . && echo "Production build and install success" || echo "[FAILED] Production install"
|
> @go install -ldflags=${linkerflags} . && echo "Production build and install success" || echo "[FAILED] Production install"
|
||||||
|
|
||||||
## Commands that don't relate to a specific file
|
## Commands that don't relate to a specific file
|
||||||
.PHONY: help confirm clean prep build build-production
|
.PHONY: help confirm clean prep build build-production linux windows amd64
|
||||||
@@ -1,6 +1,7 @@
|
|||||||
# scaffold
|
# scaffold
|
||||||
|
|
||||||
## Intro
|
## Intro
|
||||||
|
Use scaffold to setup a new project with a directory skeleton of your design, and if you'd like, it can also automatically initialize local, remote and gitea git repositories for the new project.
|
||||||
|
|
||||||
## Git
|
## Git
|
||||||
|
|
||||||
|
|||||||
@@ -11,85 +11,6 @@ scaffold go NewGoProject
|
|||||||
scaffold py aPythonProject
|
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
|
var cfg_content = `# Scaffold program configuration
|
||||||
|
|
||||||
# Format: TOML - see https://toml.io for details
|
# Format: TOML - see https://toml.io for details
|
||||||
|
|||||||
106
examples/example_scaffold-go.toml
Normal file
106
examples/example_scaffold-go.toml
Normal 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"
|
||||||
33
main.go
33
main.go
@@ -10,6 +10,7 @@ import (
|
|||||||
"os/exec"
|
"os/exec"
|
||||||
"os/user"
|
"os/user"
|
||||||
"path/filepath"
|
"path/filepath"
|
||||||
|
"runtime"
|
||||||
"strconv"
|
"strconv"
|
||||||
|
|
||||||
"github.com/BurntSushi/toml"
|
"github.com/BurntSushi/toml"
|
||||||
@@ -30,8 +31,13 @@ type (
|
|||||||
Create_Remote_Repo bool
|
Create_Remote_Repo bool
|
||||||
Remote_User string
|
Remote_User string
|
||||||
Remote_Location string
|
Remote_Location string
|
||||||
Remote_Shortname string
|
Remote_Label string
|
||||||
Commands [][]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 {
|
ScaffoldSetup struct {
|
||||||
TestKey string
|
TestKey string
|
||||||
@@ -55,6 +61,15 @@ func main() {
|
|||||||
if *infoFlag || *infoFlag2 {
|
if *infoFlag || *infoFlag2 {
|
||||||
fmt.Printf("Scaffold version: %s", buildVersion)
|
fmt.Printf("Scaffold version: %s", buildVersion)
|
||||||
fmt.Printf("Built: %s\n", buildTime)
|
fmt.Printf("Built: %s\n", buildTime)
|
||||||
|
|
||||||
|
if runtime.GOOS == "windows" {
|
||||||
|
fmt.Println("It's a windows system")
|
||||||
|
}
|
||||||
|
|
||||||
|
ucfgd, err := os.UserConfigDir()
|
||||||
|
ifFerr("Unable to determine user config directory", err)
|
||||||
|
fmt.Println("System says -- user config directory: ", ucfgd)
|
||||||
|
|
||||||
os.Exit(0)
|
os.Exit(0)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -79,6 +94,7 @@ func main() {
|
|||||||
_, err = cfgfd.WriteString(cfg_content)
|
_, err = cfgfd.WriteString(cfg_content)
|
||||||
ifFerr("Unable to write scaffold configuration file content", err)
|
ifFerr("Unable to write scaffold configuration file content", err)
|
||||||
fmt.Println("Wrote new scaffold configuration file")
|
fmt.Println("Wrote new scaffold configuration file")
|
||||||
|
|
||||||
_, err = toml.Decode(cfg_content, &setup)
|
_, err = toml.Decode(cfg_content, &setup)
|
||||||
ifFerr("[Failed] to parse config file", err)
|
ifFerr("[Failed] to parse config file", err)
|
||||||
} else {
|
} else {
|
||||||
@@ -235,7 +251,7 @@ func main() {
|
|||||||
|
|
||||||
// add remote to local repo
|
// add remote to local repo
|
||||||
new_remote_repo := npsetup.Remote_User + ":" + npsetup.Remote_Location + "/" + newProjectName + ".git"
|
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)
|
ifFerr("Unable to set git remote for new repo", err)
|
||||||
fmt.Println("Added remote repo to git as origin")
|
fmt.Println("Added remote repo to git as origin")
|
||||||
|
|
||||||
@@ -247,6 +263,19 @@ func main() {
|
|||||||
fmt.Println("Pushed initial commit to remote")
|
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)
|
fmt.Printf("New %s Project: %s ready\n", projType, newProjectName)
|
||||||
|
|||||||
Reference in New Issue
Block a user