Updates to release workflow (#11)

- Now uses poetry
- Added Github Actions workflow to publish a release

Author: tobiasge

.github/workflows/linter.yml

@@ -0,0 +1,31 @@
+---
+name: Run github/super-linter
+
+on:
+  workflow_call:
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    name: Checks syntax of our code
+    steps:
+      - id: git-checkout
+        name: Checkout
+        uses: actions/checkout@v3
+        with:
+          # Full git history is needed to get a proper
+          # list of changed files within `super-linter`
+          fetch-depth: 0
+      - name: Lint Code Base
+        uses: github/super-linter@v4
+        env:
+          DEFAULT_BRANCH: main
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          SUPPRESS_POSSUM: true
+          VALIDATE_ALL_CODEBASE: false
+          LINTER_RULES_PATH: /
+          PYTHON_BLACK_CONFIG_FILE: pyproject.toml
+          FILTER_REGEX_EXCLUDE: (.*/)?(LICENSE)
+          YAML_CONFIG_FILE: .yamllint.yaml
+          PYTHON_FLAKE8_CONFIG_FILE: .flake8
+          PYTHON_ISORT_CONFIG_FILE: pyproject.toml

.github/workflows/pr-test.yml

@@ -6,36 +6,6 @@ on:
 
 jobs:
   lint:
-    runs-on: ubuntu-latest
-    name: Checks syntax of our code
-    steps:
-      - uses: actions/checkout@v3
-        with:
-          # Full git history is needed to get a proper
-          # list of changed files within `super-linter`
-          fetch-depth: 0
-      - name: Lint Code Base
-        uses: github/super-linter@v4
-        env:
-          DEFAULT_BRANCH: main
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          SUPPRESS_POSSUM: true
-          VALIDATE_ALL_CODEBASE: false
-          LINTER_RULES_PATH: /
-          PYTHON_BLACK_CONFIG_FILE: src/pyproject.toml
-          FILTER_REGEX_EXCLUDE: (.*/)?(LICENSE)
-          YAML_CONFIG_FILE: .yamllint.yaml
-          PYTHON_FLAKE8_CONFIG_FILE: .flake8
-          PYTHON_ISORT_CONFIG_FILE: src/pyproject.toml
+    uses: ./.github/workflows/linter.yml
   tests:
-    runs-on: ubuntu-latest
-    name: Run initializer test script
-    steps:
-      - id: git-checkout
-        name: Checkout
-        uses: actions/checkout@v3
-      - id: test-script
-        name: Test the initializers
-        run: |
-          cd test
-          ./test.sh
+    uses: ./.github/workflows/tests.yml

.github/workflows/release.yml

@@ -0,0 +1,29 @@
+---
+name: Publish release
+
+on:
+  release:
+    types:
+      - "released"
+  workflow_dispatch:
+
+jobs:
+  lint:
+    uses: ./.github/workflows/linter.yml
+  tests:
+    uses: ./.github/workflows/tests.yml
+  release:
+    runs-on: ubuntu-latest
+    name: Release to PyPi
+    needs: [lint, tests]
+    steps:
+      - id: git-checkout
+        name: Checkout
+        uses: actions/checkout@v3
+      - id: build-and-publish
+        name: Build and publish to pypi
+        uses: JRubics/[email protected]
+        with:
+          pypi_token: ${{ secrets.PYPI_TOKEN }}
+          repository_name: "testpypi"
+          repository_url: "https://test.pypi.org/legacy/"

.github/workflows/tests.yml

@@ -0,0 +1,19 @@
+---
+name: Run tests
+
+on:
+  workflow_call:
+
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+    name: Run initializer test script
+    steps:
+      - id: git-checkout
+        name: Checkout
+        uses: actions/checkout@v3
+      - id: test-script
+        name: Test the initializers
+        run: |
+          cd test
+          ./test.sh

Release.md

@@ -1,4 +1,4 @@
-# Build a release
+# Build a release manually
 
 Please follow these steps to produce a release
 
@@ -8,31 +8,24 @@ Checkout the branch for which the release is to be build. If no branch exists fo
 
 ## Set version number
 
-For patch releases the version number in `setup.py` and the `NetBoxInitializersConfig` needs to be updated. If the release is for a new Netbox version additional changes need to be made in `README.md` and `Dockerfile` (for tests).
+For patch releases the version number in `pyproject.toml` and the `NetBoxInitializersConfig` needs to be updated. If the release is for a new Netbox version additional changes need to be made in `README.md` and `Dockerfile` (for tests).
 
 ## Build the packages
 
 Install the needed Python packages for the build:
 
 ```bash
-pip install --upgrade pip setuptools wheel twine build
+pip install --upgrade poetry
 ```
 
 Then run the build for the wheel and source distributions:
 
 ```bash
-python -m build --sdist
-python -m build --wheel
+poetry build
 ```
 
-Check the release with twine:
+## Upload packages to PyPi
 
 ```bash
-twine check dist/*
-```
-
-## Upload packeges to PyPi
-
-```bash
-twine upload dist/*
+poetry publish
 ```

pyproject.toml

@@ -0,0 +1,28 @@
+[tool.poetry]
+authors = ["Tobias Genannt <[email protected]>"]
+description = "Load initial data into Netbox"
+license = "Apache-2.0"
+name = "netbox-initializers"
+readme = "README.md"
+repository = "https://github.com/tobiasge/netbox-initializers"
+version = "3.2.2"
+
+[tool.poetry.dependencies]
+python = "^3.8"
+"ruamel.yaml" = "0.17.21"
+
+[build-system]
+build-backend = "poetry.core.masonry.api"
+requires = ["poetry-core"]
+
+[tool.black]
+line_length = 100
+target-version = ['py310']
+
+[tool.isort]
+line_length = 100
+multi_line_output = 3
+profile = "black"
+
+[tool.pylint.format]
+max-line-length = "100"

src/pyproject.toml

@@ -2,6 +2,6 @@ FROM netboxcommunity/netbox:v3.2
 
 COPY ../ /opt/netbox-initializers/
 COPY ./test/config/plugins.py /etc/netbox/config/
-WORKDIR /opt/netbox-initializers/src/
+WORKDIR /opt/netbox-initializers/
 RUN /opt/netbox/venv/bin/pip install -e .
 WORKDIR /opt/netbox/netbox

src/setup.py

@@ -21,7 +21,7 @@ test_setup() {
       sed -E 's/^# //' "${script}" >"../../../../test/${INITIALIZERS_DIR}/${script}"
     done
   )
-  $doco build --no-cache
+  $doco build --no-cache || exit 1
 }
 
 test_cleanup() {
@@ -37,7 +37,7 @@ test_cleanup() {
 
 test_initializers() {
   echo "🏭 Testing Initializers"
-  $doco run --rm netbox /opt/netbox/docker-entrypoint.sh ./manage.py load_initializer_data --path /etc/netbox/initializer-data
+  $doco run --rm netbox /opt/netbox/docker-entrypoint.sh ./manage.py load_initializer_data --path /etc/netbox/initializer-data || exit 1
 }
 
 echo "🐳🐳🐳 Start testing"