Skip to content

RELEASE.md

Latest commit

 

History

History
63 lines (57 loc) · 1.53 KB

RELEASE.md

File metadata and controls

63 lines (57 loc) · 1.53 KB

Trafix Release Workflow

This document describes how to make a new release of the trafix project, including versioning, tagging, and RPM packaging for Fedora. Ensure you have the following installed:

  • rpm-build
  • rpmdevtools
  • gcc, make
  • git
  • libpcap-devel, ncurses-devel, lm_sensors
  • A proper ~/rpmbuild structure:
	rpmdev-setuptree
  • License check
	licensecheck -r .

Workflow

  1. Make Code Changes: Make your changes in the source code.
	nano src/main.c
	git add src/main.c
	git commit -m "Fix: correct packet stats rendering"
  1. Bump the Version: Update the VERSION file and changelog automatically.
	make bump patch/minor/major
  1. Create a Git Tag: Tag the release using the version from the VERSION file.
	make tag
  1. Copy the Spec File: Copy trafix.spec into the correct RPM build directory.
	make copy-spec
  1. Build the RPM: Build both the binary and source RPM packages.
	make rpm

Note: Source tarball creation is no longer needed - GitHub automatically generates archives from git tags.

Simplified Workflow

  1. Make Code Changes: Make your changes in the source code.
	nano src/main.c
	git add src/main.c
	git commit -m "Fix: correct packet stats rendering"
  1. Bump the Version: Update the VERSION file and changelog automatically.
	make bump
  1. One-Command Full Release: Creates tag, copies spec, and builds RPM all in one go.
	make release