Compare commits

...

2 commits

Author SHA1 Message Date
74c447b282 add CONTRIBUTING.md
All checks were successful
check code / check-code (push) Successful in 19s
2024-02-20 09:13:23 +01:00
86789a1c4b update ci files for future releases 2024-02-20 08:59:05 +01:00
6 changed files with 79 additions and 27 deletions

View file

@ -1,16 +0,0 @@
name: build and publish
on:
push:
tags:
- "v*.*.*"
pull_request:
branches: [main, master]
jobs:
build-pypackage:
uses: actions/workflows/.gitea/workflows/build_pypackage.yml@master
secrets:
username: __token__
token: ${{ secrets.PACKAGE_TOKEN }}

View file

@ -0,0 +1,22 @@
name: build and publish
on:
push:
tags:
- "v*.*.*"
pull_request:
branches: [main, master]
jobs:
build-pypackage:
uses: actions/workflows/.gitea/workflows/release_pypackage_github.yml@master
with:
repository: main
secrets:
username: __token__
token: ${{ secrets.PACKAGE_TOKEN }}
gh-token: ${{ secrets.GH_TOKEN }}
update-changelog:
uses: actions/workflows/.gitea/workflows/update_changelog.yml@master

View file

@ -1,10 +0,0 @@
name: update changelog
on:
push:
tags:
- "v*.*.*"
jobs:
update-changelog:
uses: actions/workflows/.gitea/workflows/update_changelog.yml@master

View file

@ -0,0 +1,14 @@
name: check code
on:
push:
branches: [main, master]
pull_request:
branches: [main, master]
jobs:
check-code:
uses: actions/workflows/.gitea/workflows/check_python_hatch.yml@master
with:
run-tests: false

42
CONTRIBUTING.md Normal file
View file

@ -0,0 +1,42 @@
# getting started
## with asdf
### tools needed
- python 3.11
- [hatch](https://hatch.pypa.io/)
- [asdf](https://asdf-vm.com/guide/getting-started.html)
### setup
1. install [asdf](https://asdf-vm.com/guide/getting-started.html)
2. run `asdf install` in this directory to install all needed tools
3. run `just setup` to install the pre-commit hooks etc.
### pre-commit
1. run `just check` to lint the files and auto-format them.
you can optionally run `just format` and `just lint` as a single action.
2. fix the issues which ruff reports
3. run `just build` to check if it builds correctly
4. commit changes
## manual
### tools needed
- python 3.11
- [hatch](https://hatch.pypa.io/)
### setup
1. install [just](https://github.com/casey/just)
2. run `just setup` to install the pre-commit hooks etc.
### pre-commit
1. run `hatch run lint:fmt` to lint the files and auto-format them.
2. fix the issues which ruff reports
3. run `hatch build --clean` to check if it builds correctly
4. commit changes

View file

@ -231,7 +231,7 @@ class NetBoxDNSSource(octodns.source.base.BaseSource):
raise LookupError raise LookupError
nb_records: pynetbox.core.response.RecordSet = self.api.plugins.netbox_dns.records.filter( nb_records: pynetbox.core.response.RecordSet = self.api.plugins.netbox_dns.records.filter(
zone_id=nb_zone.id zone_id=nb_zone.id, status="active"
) )
for nb_record in nb_records: for nb_record in nb_records:
rcd_name: str = nb_record.name if nb_record.name != "@" else "" rcd_name: str = nb_record.name if nb_record.name != "@" else ""