Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Change git remote paths from HTTPS to SSH #502

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion copier.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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 %}
Expand Down
2 changes: 1 addition & 1 deletion docs/source/new_project.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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}}``
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same here - it's about creating web URLs (e.g. for readme badges) so should stay HTTP.

* - *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.
Expand Down
4 changes: 2 additions & 2 deletions docs/source/template_options.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <project_name>``.

Expand Down Expand Up @@ -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}}``.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This line in documentation is specifically about constructing web URLs, so should remain HTTP.



5. Name of the code author
Expand Down
Loading