diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml index dfe9c849..5b478d7a 100644 --- a/.github/workflows/lint.yml +++ b/.github/workflows/lint.yml @@ -13,7 +13,7 @@ jobs: steps: - name: Checkout code - uses: actions/checkout@main + uses: actions/checkout@0c366fd6a839edf440554fa01a7085ccba70ac98 - name: Check conformance to Black standards uses: psf/black@e015af4a681dd2ac847188b13a81dc4a573d4dcb diff --git a/.github/workflows/manifest-modified.yaml b/.github/workflows/manifest-modified.yaml deleted file mode 100644 index bac4e7a3..00000000 --- a/.github/workflows/manifest-modified.yaml +++ /dev/null @@ -1,18 +0,0 @@ -name: NetBox plugin manifest modified - -permissions: - contents: read - -on: - push: - branches: [ main ] - paths: - - netbox-plugin.yaml - -concurrency: - group: ${{ github.workflow }} - cancel-in-progress: false - -jobs: - manifest-modified: - uses: netboxlabs/public-workflows/.github/workflows/reusable-plugin-manifest-modified.yml@release diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml index fd9f1361..429356c8 100644 --- a/.github/workflows/publish.yml +++ b/.github/workflows/publish.yml @@ -17,10 +17,10 @@ jobs: steps: - name: Checkout code - uses: actions/checkout@main + uses: actions/checkout@0c366fd6a839edf440554fa01a7085ccba70ac98 - name: Setup Python - uses: actions/setup-python@main + uses: actions/setup-python@4f41a90a1f38628c7ccc608d05fbafe701bc20ae with: python-version: "3.12" diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index 1f8c2347..8b894e99 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -36,17 +36,17 @@ jobs: steps: - name: Checkout code - uses: actions/checkout@main + uses: actions/checkout@0c366fd6a839edf440554fa01a7085ccba70ac98 with: path: netbox-plugin-dns - name: Set up Python ${{ matrix.python-version }} - uses: actions/setup-python@main + uses: actions/setup-python@4f41a90a1f38628c7ccc608d05fbafe701bc20ae with: python-version: ${{ matrix.python-version }} - name: Checkout NetBox - uses: actions/checkout@main + uses: actions/checkout@0c366fd6a839edf440554fa01a7085ccba70ac98 with: repository: "netbox-community/netbox" path: netbox diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 048288fb..14ae9024 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -22,7 +22,8 @@ Include the following information in your post: * All code submissions should meet the following criteria, which are automatically checked by the GitHub CI workflow: * Python syntax is valid * `black` code formatting is enforced - * `/opt/netbox/venv/bin/manage.py test netbox_dns' successful + * ruff code checking is enforced. + * `/opt/netbox/venv/bin/manage.py test netbox_dns` must run successfully. * Include a reference to the fixed bug or feature request in the description of the pull request, e.g. `fixes #23`. See the [GitHub documentation](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/using-keywords-in-issues-and-pull-requests) for details * If the main branch has moved on while you were working on a pull request, please __do not merge but rebase__ your branch. Merging normally isn't usually necessary, and it creates merge commits that unnecessarily clutter the project's history @@ -86,8 +87,9 @@ PLUGINS = [ After these steps are completed successfully, you're all set up. -## Formatting your code with `black` -To achieve a consistent coding style, all code for the NetBox DNS plugin is formatted using the `black` utility. For more details, see the [documentation](https://black.readthedocs.io/en/stable/index.html) for `black`. +## Code formatting and linting + +To achieve a consistent coding style, all code for the NetBox DNS plugin is formatted using the [`black` formatter](https://black.readthedocs.io/en/stable/index.html) and checked for inconsistencies such as unused imports and variables using the [`ruff` linter](https://docs.astral.sh/ruff/linter/). ``` $ /opt/netbox/venv/bin/black netbox_dns diff --git a/LICENSE b/LICENSE index f745658d..53c3271a 100644 --- a/LICENSE +++ b/LICENSE @@ -2,6 +2,7 @@ MIT License Copyright (c) 2021-2023 Aurora Research Lab Copyright (c) 2023 Peter Eckel +Copyright (c) 2026 Peter Eckel, sys4 AG Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README.md b/README.md index f08df17d..ce7be231 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,15 @@ # NetBox DNS + The NetBox DNS plugin enables NetBox to manage operational DNS data such as name servers, zones, records and views, as well as registration data for domains. It can automate tasks like creating PTR records, generating zone serial numbers, NS and SOA records, as well as validate names and values values for resource records to ensure zone data is consistent, up-to-date and compliant with to the relevant RFCs.
PyPi -Stars Badge -Forks Badge -Issues Badge -Pull Requests Badge -GitHub contributors -License Badge +Stars Badge +Forks Badge +Issues Badge +Pull Requests Badge +GitHub contributors +License Badge Code Style Black Downloads Downloads/Week diff --git a/pyproject.toml b/pyproject.toml index 10a80c0c..626a0be2 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -3,7 +3,7 @@ name = "netbox-plugin-dns" version = "1.5.2" description = "NetBox DNS is a NetBox plugin for managing DNS data." authors = [ - {name="Peter Eckel", email="pete@netbox-dns.org"}, + {name="Peter Eckel", email="pe@sys4.de"}, ] license-files = [ "LICENSE" @@ -23,10 +23,10 @@ dependencies = [ requires-python = ">=3.12" [project.urls] -Homepage = "https://github.com/peteeckel/netbox-plugin-dns" -Documentation = "https://github.com/peteeckel/netbox-plugin-dns/blob/main/docs/using_netbox_dns.md" -Repository = "https://github.com/peteeckel/netbox-plugin-dns" -Issues = "https://github.com/peteeckel/netbox-plugin-dns/issues" +Homepage = "https://github.com/sys4/netbox-plugin-dns" +Documentation = "https://github.com/sys4/netbox-plugin-dns/blob/main/docs/using_netbox_dns.md" +Repository = "https://github.com/sys4/netbox-plugin-dns" +Issues = "https://github.com/sys4/netbox-plugin-dns/issues" [build-system] requires = ['setuptools']