Skip to content

Commit 2a6dba6

Browse files
committed
update deploy docs
1 parent eec837d commit 2a6dba6

File tree

2 files changed

+14
-21
lines changed

2 files changed

+14
-21
lines changed

{{cookiecutter.hyphenated}}/CONTRIBUTING.md

Lines changed: 13 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -69,27 +69,28 @@ Ready to contribute? Here's how to set up `{{ cookiecutter.hyphenated }}` for lo
6969
$ git clone [email protected]:your_name_here/{{ cookiecutter.hyphenated }}.git
7070
```
7171
72-
3. Install dependencies and start your virtualenv:
72+
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/)):
7373
7474
```
75-
$ poetry install -E test -E doc -E dev
75+
$ source ~/.venv/netbox/bin/activate
7676
```
7777
78-
4. Create a branch for local development:
78+
4. Add the plugin to NetBox virtual environment in Develop mode (see [Plugins Development](https://docs.netbox.dev/en/stable/plugins/development/)):
79+
80+
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):
7981
8082
```
81-
$ git checkout -b name-of-your-bugfix-or-feature
83+
$ python setup.py develop
8284
```
8385
84-
Now you can make your changes locally.
85-
86-
5. When you're done making changes, check that your changes pass the
87-
tests, including testing other Python versions, with tox:
86+
5. Create a branch for local development:
8887
8988
```
90-
$ poetry run tox
89+
$ git checkout -b name-of-your-bugfix-or-feature
9190
```
9291
92+
Now you can make your changes locally.
93+
9394
6. Commit your changes and push your branch to GitHub:
9495
9596
```
@@ -108,21 +109,13 @@ Before you submit a pull request, check that it meets these guidelines:
108109
2. If the pull request adds functionality, the docs should be updated. Put
109110
your new functionality into a function with a docstring, and add the
110111
feature to the list in README.md.
111-
3. The pull request should work for Python 3.6, 3.7, 3.8 and 3.9. Check
112+
3. The pull request should work for Python 3.8, 3.9, 3.10 and 3.11. Check
112113
https://github.com/{{ cookiecutter.github_username }}/{{ cookiecutter.hyphenated }}/actions
113114
and make sure that the tests pass for all supported Python versions.
114115
115116
116117
## Deploying
117118
118119
A reminder for the maintainers on how to deploy.
119-
Make sure all your changes are committed (including an entry in CHANGELOG.md).
120-
Then run:
121-
122-
```
123-
$ poetry run bump2version patch # possible: major / minor / patch
124-
$ git push
125-
$ git push --tags
126-
```
127-
128-
GitHub Actions will then deploy to PyPI if tests pass.
120+
Make sure all your changes are committed (including an entry in CHANGELOG.md) and that all tests pass.
121+
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:

{{cookiecutter.hyphenated}}/mkdocs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ extra:
6161
link: https://github.com/netbox-community/cookiecutter-netbox-plugin
6262
name: Facebook
6363
- icon: fontawesome/brands/github
64-
link: https://github.com/{{ cookiecutter.github_username }}/{{ cookiecutter.underscored }}
64+
link: https://github.com/{{ cookiecutter.github_username }}/{{ cookiecutter.hyphenated }}
6565
name: Github
6666
- icon: material/email
6767
link: "mailto:{{ cookiecutter.email }}"

0 commit comments

Comments
 (0)