chore: update forgejo-runner exec defaults and reword the help #1004

earl-warren · 2025-09-16T16:12:58Z

earl-warren commented

2025-09-16 16:12:58 +00:00

The help is trimmed to a subset of options that are implemented. The unsupported options are made less visible in this way while still being available to avoid a breaking change. They can then be deprecated one by one at a later time.

Refs forgejo/runner#619
Refs forgejo/runner#577

other
- PR: chore: update forgejo-runner exec defaults and reword the help

The help is trimmed to a subset of options that are implemented. The unsupported options are made less visible in this way while still being available to avoid a breaking change. They can then be deprecated one by one at a later time. Refs forgejo/runner#619 Refs forgejo/runner#577   - other - [PR](https://code.forgejo.org/forgejo/runner/pulls/1004): chore: update forgejo-runner exec defaults and reword the help

earl-warren added the

Kind/Enhancement

label

2025-09-16 16:12:58 +00:00

earl-warren self-assigned this

2025-09-16 16:12:58 +00:00

earl-warren force-pushed wip-exec from 65339d685c

cascade / forgejo (pull_request_target) Has been skipped

Details

cascade / debug (pull_request_target) Has been skipped

Details

cascade / end-to-end (pull_request_target) Has been skipped

Details

issue-labels / release-notes (pull_request_target) Successful in 6s

Details

checks / validate mocks (pull_request) Successful in 36s

Details

checks / build and test (pull_request) Successful in 46s

Details

checks / runner exec tests (pull_request) Successful in 25s

Details

checks / runner integration tests (pull_request) Successful in 4m18s

Details

/ example-lxc-systemd (pull_request) Successful in 6m18s

Details

checks / integration tests (pull_request) Successful in 11m2s

Details

to d26e633b71

checks / validate mocks (pull_request) Successful in 35s

Details

checks / build and test (pull_request) Successful in 45s

Details

checks / runner exec tests (pull_request) Successful in 29s

Details

checks / runner integration tests (pull_request) Successful in 4m24s

Details

/ example-lxc-systemd (pull_request) Successful in 6m14s

Details

checks / integration tests (pull_request) Successful in 10m48s

Details

issue-labels / release-notes (pull_request_target) Successful in 6s

Details

cascade / debug (pull_request_target) Has been skipped

Details

cascade / end-to-end (pull_request_target) Successful in 6s

Details

cascade / forgejo (pull_request_target) Successful in 1m48s

Details

2025-09-16 16:27:49 +00:00

Compare

earl-warren referenced this pull request

2025-09-16 16:29:20 +00:00

bug: inconsistencies in repo URI parsing when running locally #619

earl-warren

2025-09-16 16:29:42 +00:00

added
Kind/Chore
and removed
Kind/Enhancement
labels
requested review from sclu1034

earl-warren referenced this pull request

2025-09-16 21:07:36 +00:00

bug: --container-daemon-socket parameter does not apply to runner #577

earl-warren referenced this pull request

2025-09-16 21:08:54 +00:00

cmd: exec: prefer docker socket path from DOCKER_HOST if specified #598

earl-warren referenced this pull request

2025-09-16 21:09:09 +00:00

fix: apply --container-daemon-socket correctly [skip cascade] #581

sclu1034 reviewed

2025-09-17 14:02:37 +00:00

internal/app/cmd/exec.go

					
				@ -478,1 +478,4 @@

					// Trim the help to a subset of options that are supported. The unsupported options

					// are made less visible in this way while still being available to avoid a breaking change.

					// They can then be deprecated one by one.

Not sure about deprecating some of them.
Are they deprecated because of known issues? If so, I'm not aware of them.

--forgejo-instance is still necessary to get the origin parsing working
A feature like --dryrun is a huge help in not having to manually add if: false lines again and again. If it doesn't fully work, I'd rather it be kept with a warning like "Experimental, might not work in all cases" and an issue somewhere to collect the cases where it needs improvement
--list is extremely helpful when you aren't entirely sure how the runner finds workflows, and is much easier than to ls a bunch of different directories
--insecure-secrets is actually very helpful for security: If I wanted to check whether my custom action accidentally logs a secret, I can set that to a known value, then grep the log. It's much harder to grep for the replacement value
I can imaging how --pull and --rebuild could be helpful, even if just for something like "let's make absolutely sure the runner has the newest image, so I can rule out that and look elsewhere"
--network is probably helpful in certain environments, e.g. when the hosted runner would also have access to some shared resources and you want to simulate that locally

Not sure about deprecating some of them. Are they deprecated because of known issues? If so, I'm not aware of them. - `--forgejo-instance` is still necessary to get the origin parsing working - A feature like `--dryrun` is a huge help in not having to manually add `if: false` lines again and again. If it doesn't fully work, I'd rather it be kept with a warning like "Experimental, might not work in all cases" and an issue somewhere to collect the cases where it needs improvement - `--list` is extremely helpful when you aren't entirely sure how the runner finds workflows, and is much easier than to `ls` a bunch of different directories - `--insecure-secrets` is actually very helpful for security: If I wanted to check whether my custom action accidentally logs a secret, I can set that to a known value, then grep the log. It's much harder to grep for the replacement value - I can imaging how `--pull` and `--rebuild` could be helpful, even if just for something like "let's make absolutely sure the runner has the newest image, so I can rule out that and look elsewhere" - `--network` is probably helpful in certain environments, e.g. when the hosted runner would also have access to some shared resources and you want to simulate that locally

When running within a repository with the origin remote set, here is what I get:

$ forgejo-runner-11.0.0 exec -W /tmp/f.yml -j test -d
| FORGEJO_REPOSITORY=forgejo/runner
| FORGEJO_REPOSITORY_OWNER=forgejo
| FORGEJO_SHA=2e2e084613442e73d895c726673b24f1f943ffd9
| FORGEJO_REF=refs/heads/wip-validate

What specifically --forgejo-instance provides in addition to this?

When running within a repository with the origin remote set, here is what I get: ```sh $ forgejo-runner-11.0.0 exec -W /tmp/f.yml -j test -d | FORGEJO_REPOSITORY=forgejo/runner | FORGEJO_REPOSITORY_OWNER=forgejo | FORGEJO_SHA=2e2e084613442e73d895c726673b24f1f943ffd9 | FORGEJO_REF=refs/heads/wip-validate ``` What specifically `--forgejo-instance` provides in addition to this?

The inconsistencies detailed at #619 are still happening.

The inconsistencies detailed at https://code.forgejo.org/forgejo/runner/issues/619 are still happening.

Yes, I closed this pull request: fixing --forgejo-instance should be handled in another pull request.

Yes, I closed this pull request: fixing `--forgejo-instance` should be handled in another pull request.

internal/app/cmd/exec.go

					
				@ -479,0 +488,4 @@

				  -d, --debug                            enable debug log.

				      --default-actions-url string       Defines the default base url of the action. (default "https://data.forgejo.org")

				  -C, --directory string                 working directory. (default ".")

				      --env stringArray                  env to make available to actions with optional value (e.g. --env myenv=foo or --env myenv).

Why not -e as well?

Why not `-e` as well?

because it is not implemented currently

earl-warren marked this conversation as resolved

internal/app/cmd/exec.go

					
				@ -479,0 +490,4 @@

				  -C, --directory string                 working directory. (default ".")

				      --env stringArray                  env to make available to actions with optional value (e.g. --env myenv=foo or --env myenv).

				      --env-file string                  environment file to read and use as env in the containers. (default ".env")

				  -E, --event string                     run a event name (e.g push, pull_request, ...).

Should probably mention that the default is what --detect-event did.

Should probably mention that the default is what `--detect-event` did.

👍 1

good point

internal/app/cmd/exec.go

					
				@ -479,0 +495,4 @@

				  -i, --image string                     Docker image to use. (default "node:20-bookworm")

				  -j, --job string                       run a specific job ID.

				  -s, --secret stringArray               secret to make available to actions with optional value (e.g. -s mysecret=foo or -s mysecret).

				      --var stringArray                  variable to make available to actions with optional value (e.g. --var myvar=foo or --var myvar).

Why not -v as well?

Why not `-v` as well?

because it is not implemented currently

earl-warren marked this conversation as resolved

earl-warren closed this pull request

2025-09-17 16:02:10 +00:00

checks / validate mocks (pull_request) Successful in 35s

Details

checks / build and test (pull_request) Successful in 45s

Details

checks / runner exec tests (pull_request) Successful in 29s

Details

checks / runner integration tests (pull_request) Successful in 4m24s

Details

/ example-lxc-systemd (pull_request) Successful in 6m14s

Details

checks / integration tests (pull_request) Successful in 10m48s

Details

issue-labels / release-notes (pull_request_target) Successful in 6s

Details

cascade / debug (pull_request_target) Has been skipped

Required

Details

cascade / end-to-end (pull_request_target) Successful in 6s

Required

Details

cascade / forgejo (pull_request_target) Successful in 1m48s

Required

Details

checks / Build Forgejo Runner *

Required

checks / Run exec tests *

Required

checks / Run integration tests with *

Required

Pull request closed

Please reopen this pull request to perform a merge.

Sign in to join this conversation.

No reviewers

No milestone

No assignees

2 participants

Notifications

Due date

The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set

Reference

forgejo/runner!1004

Rows
Columns