Skip to content

556-remove next_steps.md and show its content as a user message #609

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.

Sign up for GitHub

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

Merged
fdiblen merged 5 commits into from
Aug 27, 2024
Merged

556-remove next_steps.md and show its content as a user message #609

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
0c26d01
remove next_steps.md and show its content as a user message
fdiblen Aug 27, 2024
7203346
update the changelog
fdiblen Aug 27, 2024
ff75057
fix next steps message formatting
fdiblen Aug 27, 2024
1fa94dc
fix next steps message formatting
fdiblen Aug 27, 2024
24133d3
Merge branch 'main' into 556_next_steps
fdiblen Aug 27, 2024
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
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
* Make online documentation optional [#476](https://github.com/NLeSC/python-template/pull/476)

### Changed
* next_steps.md is shown as a copier message [#609](https://github.com/NLeSC/python-template/pull/609)
* Updated the user documentation (README.md) of the template [#569](https://github.com/NLeSC/python-template/pull/569)
* Droped Python 3.8 and 3.9 support [#551](https://github.com/NLeSC/python-template/pull/551)
* Fix broken link checker [#546](https://github.com/NLeSC/python-template/pull/546)
Expand Down
34 changes: 29 additions & 5 deletions copier/messages.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,39 @@ _message_before_copy: |
input to each of them.

_message_after_copy: |
Your project "{{ package_name }}" has been created successfully!
Your project "{{ package_name }}" has been successfully created in {{ _copier_conf.dst_path }} folder!

Next steps:
{% if template_profile != 'minimum' -%}

1. Change directory to the project root:
Next steps:

$ cd {{ _copier_conf.dst_path }}
- Below are the commands to put your Python package under using git:

2. Read next_steps.md which contains information on next steps.
cd {{ _copier_conf.dst_path }}
git init
git add --all
git commit -m "first commit"
git branch -M main
git remote add origin {{ repository }}

- Push the initial commit to a new repo on GitHub

Go to https://github.com/organizations/{{github_organization}}/repositories/new
and create a new repository named `{{ package_name }}` as an empty repository, then push your commits to GitHub:

git push --set-upstream origin main

{% if AddDevDoc -%}
- Project development documentation

The README.dev.md contains developer documentation
{%- endif %}

- Project layout explained

For an explanation of what files are there, and what each of these do, please refer to {{ _copier_conf.dst_path }}/project_setup.md

{%- endif-%}

_message_before_update: |
Thanks for updating your project using our template.
Expand Down
49 changes: 0 additions & 49 deletions template/next_steps.md.jinja
View file
Open in desktop

This file was deleted.