Skip to content
Merged
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
Fixes authentication confusion
Sets the default authentication to ssh. The user is informed of this choice and provides information on how to use other forms of authentication.
  • Loading branch information
apalha committed Nov 18, 2022
commit b672a044dcdeef3c32f3a6a3a6a0b6f5ebce04d5
2 changes: 1 addition & 1 deletion hooks/pre_gen_project.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,6 @@
"package_name": cookiecutter.package_name.lower().replace(" ", "_").replace("-", "_"),
"directory_name": cookiecutter.directory_name.lower().replace(" ", "-"),
"full_name": cookiecutter.full_name.replace('\"', '\\\"'),
"repository": "https://github.com/" + cookiecutter.github_organization + "/" + cookiecutter.directory_name.lower().replace(" ", "-"),
"repository": "git@github.com:" + cookiecutter.github_organization + "/" + cookiecutter.directory_name.lower().replace(" ", "-"),
"package_short_description": cookiecutter.package_short_description.replace('\"', '\\\"')
}) }}
7 changes: 7 additions & 0 deletions {{cookiecutter.directory_name}}/next_steps.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,13 @@ Once your Python package is created, put it under [version
control](https://guide.esciencecenter.nl/#/best_practices/version_control) using
[git](https://git-scm.com/) and [GitHub](https://github.com/).

Note that the next step assumes you have setup your connection to GitHub via SSH,
see [Connecting to GitHub with SSH](https://docs.github.com/en/github-ae@latest/authentication/connecting-to-github-with-ssh).

Alternatively, you can also use a personal access token, see
[Creating a personal access token](https://docs.github.com/en/github-ae@latest/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token). If you choose this option, below you will have to replace
`git@github.com:` by `https://github.com/`.

```shell
cd {{ cookiecutter.directory_name }}
git init
Expand Down