Skip to content

Latest commit

 

History

History
37 lines (26 loc) · 1.3 KB

DEVELOPMENT.md

File metadata and controls

37 lines (26 loc) · 1.3 KB

Local development

Copy go.work.example to go.work

System requirements

  • OS requirements correspond to the server/launcher ones. Cross-compilation works on all out-the-box.
  • Go 1.22.
  • Git.
  • Task.
  • GoReleaser.

Debug

It is recommended to use an IDE such as GoLand (free for academia) or Visual Studio Code (free) with the Go extension.

Depending on the module you want to debug, you will need to run the corresponding task before:

  • server: task debug-prepare-server
    • genCert: task debug:prepare-server-genCert
  • launcher: task debug:prepare-launcher
    • config: task build-config-admin-agent
    • config-admin-agent: task build-config-admin
    • agent: task build-config-all

Build

Run task build.

Release

  1. Install gpg2 if needed.
  2. Create a new sign-only GPG key pair (RSA 4096-bit) with a passphrase.
  3. Copy .env.example to .env and set GPG_FINGERPRINT to the fingerprint of the key.
  4. Finally run task release