From eb58ed4cda35f5c39213b6e16f51b1a3abd5a20d Mon Sep 17 00:00:00 2001 From: Konstantin Malanchev Date: Fri, 6 Dec 2024 15:18:05 -0500 Subject: [PATCH] git paths: from https to ssh --- copier.yml | 2 +- docs/source/new_project.rst | 2 +- docs/source/template_options.rst | 4 ++-- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/copier.yml b/copier.yml index 55bacb1..bf34bab 100644 --- a/copier.yml +++ b/copier.yml @@ -156,7 +156,7 @@ _message_after_copy: | $ bash .initialize_new_project.sh Push your project to a new repository on GitHub: - $ git remote add origin https://github.com/{{project_organization}}/{{project_name}}.git + $ git remote add origin git@github.com:{{project_organization}}/{{project_name}}.git $ git push -u origin main {%- if include_notebooks %} diff --git a/docs/source/new_project.rst b/docs/source/new_project.rst index dcd42ac..72e2ca8 100644 --- a/docs/source/new_project.rst +++ b/docs/source/new_project.rst @@ -45,7 +45,7 @@ questions: * - *What github organization will your project live under?* - This will either be a github organization, or your github username, if you're working outside of an organization. This is used to construct URLs to your project, like - ``https://github.com/{{project_organization}}/{{project_name}}`` + ``git@github.com:{{project_organization}}/{{project_name}}`` * - *What is the name of the code author?* - The name of the code's author, or the organization that is responsible for the code. This will be used in the project and documentation metadata. diff --git a/docs/source/template_options.rst b/docs/source/template_options.rst index df3d8e3..5d962d8 100644 --- a/docs/source/template_options.rst +++ b/docs/source/template_options.rst @@ -25,7 +25,7 @@ The name of your project. Must start with a lowercase letter, followed by one or more of the following (a-z, 0-9, _, -). -This will be used to connect to your project on github, as in ``https://github.com/{{project_organization}}/{{project_name}}``. +This will be used to connect to your project on github, as in ``git@github.com:{{project_organization}}/{{project_name}}``. If you distribute your code via PyPI, this is the name that will be used. This will allow users to install like so: ``pip install ``. @@ -71,7 +71,7 @@ This will be: * Your GitHub username, if you're working outside of an organization. -This is used to construct URLs to your project, as in: ``https://github.com/{{project_organization}}/{{project_name}}``. +This is used to construct URLs to your project, as in: ``git@github.com:{{project_organization}}/{{project_name}}``. 5. Name of the code author