The nsupdate.info software Project

History

The initial version of the nsupdate.info software was developed in 48h in the DjangoDash 2013 contest by:

• Arne Schauf

• Fabian Faessler

• Thomas Waldmann

Project site

Source code repository, issue tracker (bugs, ideas about enhancements, todo, feedback, …), link to documentation is all there:

https://github.com/nsupdate-info/nsupdate.info

Translations

Translations are done on Transifex - please collaborate there to avoid double work / workflow issues:

https://app.transifex.com/thomaswaldmann/nsupdateinfo/dashboard/

You need the transifex client so you have the tx command, see:

https://developers.transifex.com/docs/cli

Please make sure to configure your notification settings so that you are notified when the translation project is updated (so you can react quickly and keep your translation fresh).

Translations update workflow

::

# start from a clean workdir, then # pull all translations from Transifex: tx pull # required: change directory to where the locale folder is located: cd src/nsupdate # update the translations with changes from the source code: django-admin makemessages -a # compile the translations to .mo files: django-admin compilemessages # push updated translation files back to Transifex: cd ../.. tx push -s -t

Contributing

Feedback is welcome.

If you find some issue, have some idea or some patch, please submit them via the issue tracker.

Or even better: if you use git, fork our repo, make your changes and submit a pull request.

For small fixes, you can even just edit the files on GitHub (GitHub will then fork, change and submit a pull request automatically).

Dependency management

Get Pipenv and checkout the Pipenv Command Reference.

Install new dependencies

See the pipenv docs.

pipenv install mypkg

Spawn a shell with correct Python paths

pipenv shell

Exit the shell with exit.

Dependency maintenance

Update requirements.txt files including transitive dependencies

pipenv update

NOTE: This is not done today and only a suggestion.

pipenv requirements --exclude-markers > requirements.d/all.txt
pipenv requirements --exclude-markers --dev-only > requirements.d/dev.txt

Verify the updated dependencies don’t include any security vulnerabilities:

pipenv check

Build locally

1. Install build (see its docs for example), e.g. via pacman -S python-build on Arch Linux.

2. Afterwards, run the command to generate pip packages in dist/:

   python -m build
   

NOTE: This is also needed before development because the command generates ./src/nsupdate/_version.py.

Run locally

1. Install dependencies pipenv install --dev

2. Generate src/nsupdate/_version.py file by running python -m build

3. Create database using pipenv run ./manage.py migrate

4. Create a superuser with pipenv run ./manage.py createsuperuser

5. Run the server with pipenv run ./manage.py runserver

Lint

Run pylint in error-only mode to check any problems:

pipenv run pylint src/nsupdate

NOTE: The project does not use pylint for formatting.

Disabling the errors-only mode in .pylintrc will show a lot of warnings.

Run tests

Tests need to run inside Docker because they depend on a BIND 9 nameserver running a specific configuration on 127.0.0.1:53.

1. Build the Docker image once, using: docker build -t nsupdate scripts/docker/

2. Then run tests via docker run --dns 127.0.0.1 -v $PWD:/app nsupdate

How to release

To make a new release, follow this checklist:

1. Check if everything is ready for a release:

   • all issues for this milestone are closed.

   • check if there are any pending fixes for security issues.

   • check Github actions CI - are all tests passing?

   • documentation is up-to-date.

   • CHANGES.rst is up-to-date.

   • Render CHANGES.rst via make html and check for markup errors.

   • did the code run on the prod website for a while? check server logs.

2. Handle Django migrations:

   • Check if there are any pending model changes: ./manage.py makemigrations.

   • Ensure migrations are tested.

3. Handle translations:

   • Follow the Translations update workflow to pull latest translations from Transifex, update them from source, and push back.

4. Create the release:

   • Update version and date in CHANGES.rst.

   • Tag the release in git: git tag -s -m "tagged/signed release x.y.z" x.y.z

   • Push the tag to GitHub: git push --tags.

   • Build the release packages: python -m build.

   • Create a release on Github, upload the sdist.

   • Upload the package to PyPI: twine upload dist/*.tar.gz.

5. After the release:

   • Close release milestone on Github.

   • Announce the release.