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

Provide org submitting instructions after generation #15

Closed
lkubb opened this issue Aug 1, 2024 · 2 comments · Fixed by #42
Closed

Provide org submitting instructions after generation #15

lkubb opened this issue Aug 1, 2024 · 2 comments · Fixed by #42

Comments

@lkubb
Copy link
Member

lkubb commented Aug 1, 2024

After generating a project that uses the salt-extensions namespace, there should be some instructions on how to submit an extension to the organization. I think it would be best if the working group came up with official instructions.

We could add them here:

_message_after_copy: |
Your Salt extension project "{{ project_name_full }}" has been created successfully!
Next steps:
1. Change directory to the project root:
$ cd {{ _copier_conf.dst_path }}
2. Initialize a Git repository:
$ git init
3. Create a Python virtual environment:
$ python -m venv venv --prompt='{{ project_name_full }}'
4. Source it:
$ source venv/bin/activate
5. Install your project and dependencies in editable mode:
$ python -m pip install -e '.[dev,tests,docs]'
6. Install pre-commit hooks:
$ pre-commit install
7. Run the pre-commit hooks (the commit will fail the first time):
$ git add . && git commit
8. Perform the initial commit:
$ git add . && git commit -m "Initial extension layout"
To run the test suite:
$ nox -e tests-3
Please update the tests :) Happy hacking!

Preliminary instructions are found in the new guide, we could just add the corresponding link after generation: https://salt-extensions.github.io/salt-extension-copier/topics/organization/submitting.html

This was originally reported here: #14

@dmurphy18
Copy link

Would also be good to include instructions on submitting the new extension to PyPI too

@lkubb
Copy link
Member Author

lkubb commented Aug 1, 2024

Yup. In the end, the process depends on whether one is in the org and uses the centralized workflows (a release is just a tag away) or has a different setup (there's currently no scaffolding for releases).

I think it might be time for a more general documentation regarding the process instead of bloating the post-generation message, see #17

Also opened a separate issue about improving the release tooling: #18

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 a pull request may close this issue.

2 participants