The package releases major and patch versions for framework and packages, and runs the @goravel-agent mention poller. The release process is very complex, so we built this package to save time.
Copy .env.example to .env and fill in only the parts you need — the file is grouped into Save GitHub events, Consume GitHub events, Notification in Discord, and shared-key comments. The unlabelled keys at the top are common to every feature: app name, key, debug flag, logging, the sqlite database, and session settings.
On macOS, scripts/setup-macos.sh does the checkout side of this: it installs the tooling it can, copies .env once and never overwrites it, generates APP_KEY, and loads the login scheduler described under Mention agent.
Release Goravel version has no section of its own: the release commands read GITHUB_TOKEN from the shared-key block, whose comment names Release Goravel version.
The Notification in Discord section is optional: leave every DISCORD_* and MAIL_* key blank and webhook events are still stored — only pull-request threads, core-role mentions, heartbeat alerts, and webhook failure mail are skipped. MAIL_* is the failure-alert channel, so it lives here even though the section is named Discord.
The release commands need a token with Read and Write access to Contents, Pull requests, and Actions, plus Read access to Checks.
Github link: https://github.com/settings/personal-access-tokens
There are three main commands: preview, major, and patch.
- Preview the release information
It's useful to preview the changes when generating the documentation.
# Preview framework and goravel-lite changes only
./artisan preview v1.16.0
# Preview all packages changes
./artisan preview v1.16.0 --packages
- Release major version
The command will release the major version for framework and all sub-packages.
# Preview mode (default)
./artisan major v1.16.0
# Real release
./artisan major v1.16.0 --real
# With optional flags
./artisan major v1.16.0 --real --refresh --framework-branch=custom-branch
Available flags for major release:
--real,-r: Perform actual release (without this flag, it's preview mode)--refresh: Refresh Go module proxy cache before release--framework-branch,-fb: Specify framework branch (useful when go mod cannot fetch the latest master)
- Release patch version
The command will release the patch version for framework and example, goravel-lite, goravel.
# Preview mode (default)
./artisan patch v1.15.1
# Real release
./artisan patch v1.15.1 -p gin@v1.15.1,fiber@v1.15.1 --real
Run command below to run test:
go test ./...
The repo also runs the @goravel-agent mention poller: it reads relay events,
routes each mention to a paseo mode (ship, review, analyze) with the
configured AI provider, and dispatches the run.
Fill in Consume GitHub events in .env.example (AGENT_BASE_URL,
AGENT_PROJECT_NAME, AGENT_ALLOWED_SENDERS, AI_PROVIDER/DEEPSEEK_API_KEY);
AGENT_PROJECT_NAME and AGENT_ALLOWED_SENDERS are required — the paseo
project each run's workspace is created in, and a comma-separated list of
GitHub usernames such as bowen, alice. poll-events refuses to start when
either is blank. AGENT_API_TOKEN is shared with Save GitHub events and
GITHUB_TOKEN is shared with Release Goravel version — both are declared in
the shared-key block. When consuming events the GITHUB_TOKEN is optional and
only enables the 👀 reaction. The paseo CLI must be on PATH. The mode
definitions (ship, review, analyze) still live in the goravel/agents
repository.
# One poll cycle
./artisan poll-events
# Scheduler: poll-events every five seconds, skipping an overlapping tick
./artisan schedule:runThe live-router feature tests skip themselves unless AI_PROVIDER and its API
key are set.
./artisan schedule:run is the scheduler itself, not one tick: it starts the
cron loop and stays up, running poll-events every five seconds and
heartbeat every minute. On macOS, scripts/setup-macos.sh installs a
LaunchAgent that runs it at every login and restarts it if it exits. It stops
with exit 1 before installing the plist when .env still has
AGENT_ALLOWED_SENDERS or AGENT_PROJECT_NAME blank, because poll-events
refuses to start without them; --skip-scheduler is the opt-out for a checkout
that only releases.
# Part of the normal setup: writes ~/Library/LaunchAgents/com.goravel.workflow.schedule.plist
scripts/setup-macos.sh
# Everything except the login scheduler
scripts/setup-macos.sh --skip-scheduler
# Boot the agent out and delete its plist
scripts/uninstall-schedule-launchd.shThe agent runs /bin/bash <checkout>/artisan schedule:run with its working
directory set to the checkout, so .env, storage/ and the sqlite path resolve
as they do by hand. It puts the go and paseo directories it found at install
time on the job's PATH, which launchd otherwise leaves at
/usr/bin:/bin:/usr/sbin:/sbin. Output goes to
storage/logs/launchd-schedule.log, which git ignores with storage. Re-run
scripts/setup-macos.sh after moving the checkout or after go or paseo
moves.
Stopping it — the uninstaller, or setup rewriting the plist — ends the job's
whole process group, so nothing is left running, but a poll that was in flight is
lost rather than finished. ExitTimeOut (120 s) is only how long launchd waits
after SIGTERM before it sends KILL.