Skip to content

Dynamic, post-creation followup steps - #415

Merged
drewoldag merged 1 commit into
mainfrom
issue/406/custom-post-copy-message
Feb 10, 2024
Merged

Dynamic, post-creation followup steps#415
drewoldag merged 1 commit into
mainfrom
issue/406/custom-post-copy-message

Conversation

@drewoldag

@drewoldag drewoldag commented Feb 9, 2024

Copy link
Copy Markdown
Collaborator

Change Description

This PR lays the groundwork for providing the user with customized follow up steps after a project has been created. We'll try to hold their hand as long as possible, right up to the point that they start writing their actual code.

An example of the output after using the "simple", default answers:

Your project "example_project" has been created successfully!

There are a few more manual steps to finish the setup.

Go to your project directory, create a virtual environment, and run the initialization script:
   $ cd science
   $ python3 -mvenv ~/.virtualenvs/example_project && source ~/.virtualenvs/example_project/bin/activate
   $ bash .prepare_project.sh

Push your project to a new repository on GitHub:
   $ git remote add origin https://github.com/my-organization/example_project.git
   $ git push -u origin main

Install pandoc to build your documentation locally
   $ conda install pandoc

Follow these instructions to set up benchmarking
   https://lincc-ppt.readthedocs.io/en/latest/practices/ci_benchmarking.html#set-up

Finally, a few items to consider:
   - Set up branch protection rules in github
   - Enable dependabot in github
   - Add another GitHub user as an administrator on the repository

(base) drew@pterodactyl code % 

Example using non-default, "custom" answers:

Note the complete GitHub urls. Also selected "slack" failure_notifications.

Your project "drewtonian" has been created successfully!

There are a few more manual steps to finish the setup.

Go to your project directory, create a virtual environment, and run the initialization script:
   $ cd science
   $ python3 -mvenv ~/.virtualenvs/drewtonian && source ~/.virtualenvs/drewtonian/bin/activate
   $ bash .prepare_project.sh

Push your project to a new repository on GitHub:
   $ git remote add origin https://github.com/drewoldag/drewtonian.git
   $ git push -u origin main

Install pandoc to build your documentation locally
   $ conda install pandoc

Follow these instructions to set up slack notifications:
   https://lincc-ppt.readthedocs.io/en/latest/practices/ci_testing.html#slack-notifications

Follow these instructions to set up performance benchmarking:
   https://lincc-ppt.readthedocs.io/en/latest/practices/ci_benchmarking.html#set-up

Finally, a few items to consider:
   - Set up branch protection rules in github
   - Enable dependabot in github
   - Add another GitHub user as an administrator on the repository

(base) drew@pterodactyl code % 

Checklist

  • This PR is meant for the lincc-frameworks/python-project-template repo and not a downstream one instead.
  • This change is linked to an open issue
  • This change includes integration testing, or is small enough to be covered by existing tests

@drewoldag
drewoldag requested review from a team and smcguire-cmu and removed request for a team February 9, 2024 23:49
@drewoldag drewoldag self-assigned this Feb 9, 2024
@drewoldag drewoldag linked an issue Feb 9, 2024 that may be closed by this pull request
@drewoldag

Copy link
Copy Markdown
Collaborator Author

I don't want to claim that this is the absolute final version of the dynamic text. I'm completely open to expanding or contracting this. Mostly this is just getting a foundation in place.

@smcguire-cmu smcguire-cmu left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Looks good!

@drewoldag
drewoldag merged commit 633f345 into main Feb 10, 2024
@drewoldag
drewoldag deleted the issue/406/custom-post-copy-message branch February 10, 2024 19:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Expand on the next steps in the post-copy message

3 participants