7 Commits

Author SHA1 Message Date
aa955c3b4f improved building 2023-04-15 13:33:09 -04:00
e65633a85a Merge branch 'main' of gitea:kevin/scaffold
because it's out of sync
2023-04-15 04:29:54 -04:00
d53ad8993c expanding for multiple platforms 2023-04-15 04:24:05 -04:00
7b7fdc0113 tiny cleanups 2023-04-13 15:40:56 -04:00
b010d63351 Update 'README.md' 2023-04-13 15:24:15 -04:00
c5447a68ae Update 'README.md' 2023-04-13 15:22:25 -04:00
6c03f880da *gitea remote and push 2023-04-13 15:13:38 -04:00
6 changed files with 160 additions and 91 deletions

3
.gitignore vendored
View File

@@ -9,5 +9,4 @@ cfg/*.env
cfg/*.toml
build/
buildTime.txt
buildVersion.txt
build*.txt

View File

@@ -24,6 +24,9 @@ endif
# Variables
#----------------------------------------------------------------
progName = scaffold
arch = amd64
winbinName = $(progName).exe
releaseTag = $(shell git describe --abbrev=0)
#----------------------------------------------------------------
# Helpers
@@ -56,12 +59,20 @@ linkerflags = '-s'
prep: clean
> date +"%F %a %T %Z" > buildTime.txt
> git describe --always --tags --dirty --long > buildVersion.txt
> mkdir -p build
build: prep
> @go build -o build/$(progName) . && echo "Build success" || echo "[FAILED] go build"
build: prep linux windows
build-production: prep
> @go build -ldflags=${linkerflags} -o build/$(progName) . && echo "production build success" || echo "[FAILED] production build"
linux:
> @GOOS=$@ GOARCH=$(arch) go build -o build/$@/$(progName) . && echo $@ "Build success" || echo $@ "[FAILED] go build"
windows:
> @GOOS=$@ GOARCH=$(arch) go build -o build/$@/$(progName)-$(arch)-$(releaseTag).exe . && 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
@@ -74,4 +85,4 @@ install-production: prep
> @go install -ldflags=${linkerflags} . && echo "Production build and install success" || echo "[FAILED] Production install"
## 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

View File

@@ -2,11 +2,13 @@
## 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 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.
***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.

View File

@@ -11,85 +11,6 @@ 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

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"

38
main.go
View File

@@ -10,6 +10,7 @@ import (
"os/exec"
"os/user"
"path/filepath"
"runtime"
"strconv"
"github.com/BurntSushi/toml"
@@ -30,8 +31,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
@@ -42,7 +48,8 @@ var (
infoFlag = flag.Bool("Info", false, "Displays the program build information and exits.")
infoFlag2 = flag.Bool("i", false, "Displays the program build information and exits.")
sep = "/"
cfg_dir = ".config/devel/scaffold"
user_cfg_dir string
cfg_dir = "devel/scaffold" // relative to <USER_CONFIG_DIR>, on linux /home/user/.config
cfg_filename = "scaffold-cfg.toml"
setup ScaffoldSetup
npsetup Setup
@@ -55,6 +62,15 @@ func main() {
if *infoFlag || *infoFlag2 {
fmt.Printf("Scaffold version: %s", buildVersion)
fmt.Printf("Built: %s\n", buildTime)
if runtime.GOOS == "windows" {
fmt.Println("It's a windows system")
}
user_cfg_dir, err := os.UserConfigDir()
ifFerr("Unable to determine user config directory", err)
fmt.Println("System says -- user config directory: ", user_cfg_dir)
os.Exit(0)
}
@@ -62,7 +78,7 @@ func main() {
u, err := user.Current()
ifFerr("Unable to get current user details", err)
homeDir := u.HomeDir
scaffold_cfg_dir := homeDir + sep + cfg_dir
scaffold_cfg_dir := user_cfg_dir + sep + cfg_dir
cfg_file := scaffold_cfg_dir + sep + cfg_filename
if _, err := os.Stat(scaffold_cfg_dir); err != nil {
@@ -79,6 +95,7 @@ func main() {
_, 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 {
@@ -235,7 +252,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")
@@ -247,6 +264,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)