aboutsummaryrefslogtreecommitdiff
path: root/tools/git-bootstrap/README.org
diff options
context:
space:
mode:
authorFranck Cuny <franck@fcuny.net>2022-06-18 14:49:16 -0700
committerFranck Cuny <franck@fcuny.net>2022-06-18 14:50:55 -0700
commit16861d7609c5224795ce2fbeab4380bf65921283 (patch)
tree5584b03e9731c914b670d9a347b5201f0fb023bd /tools/git-bootstrap/README.org
parentfeat(tools/ssh-key-to-forge): import a SSH key to a forge (diff)
downloadinfra-16861d7609c5224795ce2fbeab4380bf65921283.tar.gz
feat(tools/git-bootstrap): initialize a git repository with my defaults
This tool can be used to create a new git repository. It will create a README, add the license file, and a few other things I expect. Change-Id: I14123c8f5b7e2d23373a505a146d2c9f6c08615e Reviewed-on: https://cl.fcuny.net/c/world/+/450 Tested-by: CI Reviewed-by: Franck Cuny <franck@fcuny.net>
Diffstat (limited to 'tools/git-bootstrap/README.org')
-rw-r--r--tools/git-bootstrap/README.org13
1 files changed, 13 insertions, 0 deletions
diff --git a/tools/git-bootstrap/README.org b/tools/git-bootstrap/README.org
new file mode 100644
index 0000000..74ced1b
--- /dev/null
+++ b/tools/git-bootstrap/README.org
@@ -0,0 +1,13 @@
+#+TITLE: git-bootstrap
+
+Bootstrap a new git repository with a license, readme, and create a remote repository on GitHub.
+
+* GitHub
+When running the command, a new remote repository is created on GitHub when a token is present in the git configuration, under github.bootstrap.
+
+To create a token:
+1. go to https://github.com/settings/tokens
+2. create a token with the scope for repo
+3. store the token with =git config --global github.bootstrap <token>=
+
+To skip the creation of a repository on GitHub: =git-bootstrap -no-github <repo name>=