Add new fields to models and upgrade to NetBox v3.7.2 (#36)

Closes #10, #26, #35

.github/workflows/docker-image.yml

@@ -17,8 +17,8 @@ jobs:
       run: docker compose build --no-cache
 
     - name: Verify the Docker image
-      # clearcache is provided by Django extras, which is not loaded if netbox-slm cannot be loaded
-      run: docker compose run netbox sh -c "/opt/netbox/venv/bin/python manage.py clearcache"
+      # smoke test by checking if the migrations for app netbox_slm can be displayed
+      run: docker compose run netbox sh -c "/opt/netbox/venv/bin/python manage.py showmigrations netbox_slm"
 
     - name: Run Django tests with coverage for netbox_slm
       run: |

CODE_OF_CONDUCT.md

@@ -0,0 +1,133 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement by
+[opening a new issue in this repository's issue tracker][open issue].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations
+[open issue]: https://github.com/ICTU/netbox_slm/issues/new

CONTRIBUTING.md

@@ -0,0 +1,34 @@
+# NetBox SLM contributing guidelines
+
+## What do I need to know to help?
+
+If you are looking to help to with a code contribution our project uses, you can find inspiration in the [issue list](https://github.com/ICTU/netbox_slm/issues/).
+Additionally, review the [README](./README.md) document and [NetBox Plugin Development](https://docs.netbox.dev/en/stable/plugins/development/) docs.
+
+## How do I make a contribution?
+
+Never made an open source contribution before? Wondering how contributions work in the in our project? Here's a quick rundown!
+
+1. Find an issue that you are interested in addressing or a feature that you would like to add.
+2. Fork the repository associated with the issue to your local GitHub organization. This means that you will have a copy of the repository under **your-GitHub-username/repository-name**.
+3. Clone the repository to your local machine using `git clone https://github.com/github-username/repository-name.git`.
+4. Create a new branch for your fix using `git checkout -b branch-name-here`.
+5. Make the appropriate changes for the issue you are trying to address or the feature that you want to add.
+6. Use git `add insert-paths-of-changed-files-here` to add the file contents of the changed files to the "snapshot" git uses to manage the state of the project, also known as the index.
+7. Use `git commit -m "Insert a short message of the changes made here"` to store the contents of the index with a descriptive message.
+8. Push the changes to the remote repository using `git push origin branch-name-here`.
+9. Submit a pull request to the upstream repository.
+10. Title the pull request with a short description of the changes made and the issue or bug number associated with your change. For example, you can title an issue like so "Added more log outputting to resolve #4352".
+11. In the description of the pull request, explain the changes that you made, any issues you think exist with the pull request you made, and any questions you have for the maintainer. It's OK if your pull request is not perfect (no pull request is), the reviewer will be able to help you fix any problems and improve it!
+12. Wait for the pull request to be reviewed by a maintainer.
+13. Make changes to the pull request if the reviewing maintainer recommends them.
+14. Celebrate your success after your pull request is merged!
+
+## Where can I go for help?
+
+If you need help, you can ask questions by [opening a new issue in this repository's issue tracker](https://github.com/ICTU/netbox_slm/issues/new).
+
+## What does the Code of Conduct mean for me?
+
+Our [Code of Conduct](./CODE_OF_CONDUCT.md) means that you are responsible for treating everyone on the project with respect and courtesy regardless of their identity.
+If you are the victim of any inappropriate behavior or comments as described in our Code of Conduct, we are here for you and will do the best to ensure that the abuser is reprimanded appropriately, per our code.

README.md

@@ -1,6 +1,6 @@
-<h1 align="center">NetBox SLM</h1>
+# NetBox SLM
 
-<p align="center"><i>Netbox SLM is a plugin for lifecycle management of software components, including versions and installations.</i></p>
+<p align="center"><i>NetBox SLM is a plugin for lifecycle management of software components, including versions and installations.</i></p>
 
 <div align="center">
 <a href="https://pypi.org/project/netbox_slm/"><img src="https://img.shields.io/pypi/v/netbox_slm" alt="PyPi"/></a>
@@ -15,16 +15,16 @@
 
 ## Known Issues
 
-- WARNING: This plugin is only tested with a single Netbox version at this time.
+- WARNING: This plugin is only tested with a single NetBox version at this time.
 - CSV/Bulk imports for SoftwareProduct, Version and Installation are currently broken (WIP)
 
 ## Installation Guide
 
-When using the Docker version of Netbox, first follow the netbox-docker [quickstart](https://github.com/netbox-community/netbox-docker#quickstart) instructions to clone the netbox-docker repo and set up the ``docker-compose.override.yml``.
+When using the Docker version of NetBox, first follow the netbox-docker [quickstart](https://github.com/netbox-community/netbox-docker#quickstart) instructions to clone the netbox-docker repo and set up the ``docker-compose.override.yml``.
 
-Next, follow these instructions (based on the Netbox docker variant
+Next, follow these instructions (based on the NetBox docker variant
 [instructions](https://github.com/netbox-community/netbox-docker/wiki/Configuration#custom-configuration-files))
-to install the Netbox SLM plugin:
+to install the NetBox SLM plugin:
 
 1. Add ``netbox_slm`` to the ``PLUGINS`` list in
    ``configuration/plugins.py``.
@@ -59,7 +59,7 @@ to install the Netbox SLM plugin:
 
 Now, build the image: ``docker compose build --no-cache``
 
-And finally, run Netbox with the SLM plugin: ``docker compose up``
+And finally, run NetBox with the SLM plugin: ``docker compose up``
 
 ## Releasing Guide
 
@@ -84,8 +84,8 @@ netbox_slm plugin in developer mode*
 
 ### Setup
 
-The goal below is to run all Netbox components in Docker and run a local
-Netbox Django copy with auto-reload to develop the plugin pointing to
+The goal below is to run all NetBox components in Docker and run a local
+NetBox Django copy with auto-reload to develop the plugin pointing to
 the Dockerized postgres and redis instances, basically ignoring the
 netbox docker runtime server.
 
@@ -116,7 +116,7 @@ netbox docker runtime server.
    ]
    ```
 
-The Netbox installation above will be used to run Django management
+The NetBox installation above will be used to run Django management
 commands like runserver, makemigrations and migrate, which will be
 explained in the next steps below;
 
@@ -128,7 +128,7 @@ explained in the next steps below;
    $ ./start-netbox.sh
    ```
 
-This will start Netbox locally (requires Docker) and forward the redis
+This will start NetBox locally (requires Docker) and forward the redis
 and postgres ports to the localhost (make sure there’s no processes
 using these ports or change the dockerfiles accordingly)
 
@@ -220,3 +220,8 @@ Now you can run commands from the netbox repository like this;
 
 Visit http://127.0.0.1:8001 in the browser to see the auto reloading
 version of the netbox UI. Port 8000 is taken by the docker ran variant.
+
+
+## Get in touch
+
+Point of contact for this repository is [Mart Visser](https://github.com/MartVisser), who can be reached by [opening a new issue in this repository's issue tracker](https://github.com/ICTU/netbox_slm/issues/new).

SECURITY.md

@@ -1,13 +1,16 @@
-# Security Policy
+# NetBox SLM Security Policy
 
 ## Current status
 
-Netbox SLM is a plugin for Netbox with mostly default configuration. We advise to monitor Netbox security findings and update accordingly.
+NetBox SLM is a plugin for [NetBox](https://github.com/netbox-community/netbox/) with mostly default configuration.
+In order to stay up to date, monitor NetBox security findings and update accordingly.
 
 ## Supported Versions
 
-Only the latest version of Netbox SLM is currently being supported with security updates. We aim to keep the plugin compatible with the latest Netbox version, but have no incentive to patch older tags at this point.
+Only the latest version of NetBox SLM is currently being supported with security updates.
+The intention is to keep the plugin compatible with the most recent NetBox version(s), there is no incentive to patch older tags.
 
 ## Reporting a Vulnerability
 
-Please report security vulnerabilities by opening a ticket. The aim is to get back to you within 24 hours with a confirmation of the issue and a brief action plan or a request for more information. 
+You can privately [report a vulnerability issue in this repository's issue tracker](https://github.com/ICTU/netbox_slm/security/advisories/new).
+The aim is to get back to you within 24 hours, with a confirmation of the issue and a brief action plan or a request for more information.

ci/Dockerfile

@@ -11,7 +11,7 @@ RUN pip install -U .[build]
 RUN python -m build
 RUN pip install --no-index /build
 
-FROM netboxcommunity/netbox:v3.6.1
+FROM netboxcommunity/netbox:v3.7.2
 
 ARG PYTHON_VERSION=3.10
 COPY --from=compile-image /opt/netbox/venv/lib/python${PYTHON_VERSION}/site-packages/netbox_slm /opt/netbox/venv/lib/python${PYTHON_VERSION}/site-packages/netbox_slm

ci/Dockerfile-CI

@@ -1,4 +1,4 @@
-FROM netboxcommunity/netbox:v3.6.1
+FROM netboxcommunity/netbox:v3.7.2
 
 RUN mkdir /ci && chmod go+w /ci
 COPY ../ci/requirements_ci.txt /ci/

ci/docker-compose.yml

@@ -1,7 +1,7 @@
 version: '3.7'
 services:
   netbox: &netbox
-    image: netboxcommunity/netbox:${VERSION-v3.6.1}
+    image: netboxcommunity/netbox:${VERSION-v3.7.2}
     depends_on:
     - postgres
     - redis

netbox_slm/__init__.py

@@ -1,6 +1,6 @@
 from extras.plugins import PluginConfig
 
-__version__ = "1.5"
+__version__ = "1.6.0"
 
 
 class SLMConfig(PluginConfig):