HACKING.txt 830 B

12345678910111213141516171819
  1. This file is mostly for the maintainer.
  2. Updating a Version:
  3. 1. Update VERSION file.
  4. 2. HID_API_VERSION_MAJOR/HID_API_VERSION_MINOR/HID_API_VERSION_PATCH in hidapi.h.
  5. Before firing a new release:
  6. 1. Run the "Checks" Githtub Action
  7. 2. Make sure no defects are found at: https://scan.coverity.com/projects/hidapi
  8. 3. Fix if any
  9. Firing a new release:
  10. 1. Update the Version (if not yet updated).
  11. 2. Prepare the Release Notes.
  12. 3. Store the Release Notes into a file.
  13. 4. Create locally an annotated git tag with release notes attached, e.g.: `git tag -aF ../hidapi_release_notes hidapi-<VERSION>`
  14. 5. Push newly created tag: `git push origin hidapi-<VERSION>`
  15. 6. Grab the hidapi-win.zip from Summary page of "GitHub Builds" Action for latest master build.
  16. 7. Create a Github Release with hidapi-win.zip attached, for newly created tag.