-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
14 additions
and
21 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -69,27 +69,28 @@ Ready to contribute? Here's how to set up `{{ cookiecutter.hyphenated }}` for lo | |
$ git clone [email protected]:your_name_here/{{ cookiecutter.hyphenated }}.git | ||
``` | ||
3. Install dependencies and start your virtualenv: | ||
3. Activate the NetBox virtual environment (see the NetBox documentation under [Setting up a Development Environment](https://docs.netbox.dev/en/stable/development/getting-started/)): | ||
``` | ||
$ poetry install -E test -E doc -E dev | ||
$ source ~/.venv/netbox/bin/activate | ||
``` | ||
4. Create a branch for local development: | ||
4. Add the plugin to NetBox virtual environment in Develop mode (see [Plugins Development](https://docs.netbox.dev/en/stable/plugins/development/)): | ||
To ease development, it is recommended to go ahead and install the plugin at this point using setuptools' develop mode. This will create symbolic links within your Python environment to the plugin development directory. Call setup.py from the plugin's root directory with the develop argument (instead of install): | ||
``` | ||
$ git checkout -b name-of-your-bugfix-or-feature | ||
$ python setup.py develop | ||
``` | ||
Now you can make your changes locally. | ||
5. When you're done making changes, check that your changes pass the | ||
tests, including testing other Python versions, with tox: | ||
5. Create a branch for local development: | ||
``` | ||
$ poetry run tox | ||
$ git checkout -b name-of-your-bugfix-or-feature | ||
``` | ||
Now you can make your changes locally. | ||
6. Commit your changes and push your branch to GitHub: | ||
``` | ||
|
@@ -108,21 +109,13 @@ Before you submit a pull request, check that it meets these guidelines: | |
2. If the pull request adds functionality, the docs should be updated. Put | ||
your new functionality into a function with a docstring, and add the | ||
feature to the list in README.md. | ||
3. The pull request should work for Python 3.6, 3.7, 3.8 and 3.9. Check | ||
3. The pull request should work for Python 3.8, 3.9, 3.10 and 3.11. Check | ||
https://github.com/{{ cookiecutter.github_username }}/{{ cookiecutter.hyphenated }}/actions | ||
and make sure that the tests pass for all supported Python versions. | ||
## Deploying | ||
A reminder for the maintainers on how to deploy. | ||
Make sure all your changes are committed (including an entry in CHANGELOG.md). | ||
Then run: | ||
``` | ||
$ poetry run bump2version patch # possible: major / minor / patch | ||
$ git push | ||
$ git push --tags | ||
``` | ||
GitHub Actions will then deploy to PyPI if tests pass. | ||
Make sure all your changes are committed (including an entry in CHANGELOG.md) and that all tests pass. | ||
Then in the github project go to `Releases` and create a new release with a new tag. This will automatically upload the release to pypi: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters