feat: support offline mode #2128

TKaxv-7S · 2023-12-16T04:49:22Z

In some regions, connecting to github.com may not be as smooth.

So every time we using uses: method, it is not a good way to fetch and pull the current action content, and I think the action tag will also be rarely updated.

We can add a configurable option in OfflineMode to control it, setting the default value to false, so this will not affect other users.

PS: This feature is mainly intended for use by Gitea act_runner. If possible, I will also create a pull request over there.

wolfogre · 2023-12-20T07:58:24Z

Can you provide a detailed explanation of how offline mode works with act runner?

BTW, if you cannot access github.com, you can handle it with use: https://custom_domain/some/actions, like https://gitea.com/actions/checkout, it's supported by act runner.

ChristopherHX · 2023-12-20T10:13:24Z

In nektos act is forcepull enabled by default, I would expect that offline mode would also stop pulling existing images e.g. turning the default force-pull off.

As far as I understand, this change relies on the cache of act and skip all updates to cached actions. Due to that git.fetch can not return any errors anymore while cannot connect to github.

I assume not cached actions will be cloned once per tag and then never updated.

In act_runner forcepull is still off by default, however I don't know why it is still disabled there. It's the same as with force-rebuild beeing still disabled in act_runner. Those features beeing turned off caused bugs for users expecting uptodate images or docker actions

ChristopherHX · 2023-12-20T10:24:42Z

My plans to create a new ActionCache for nektos/act was rejected silently by all members of nektos/act, by not commenting at all

That would also have an easy offline mode, even with remote action overrides to a local folder of your choice.

TKaxv-7S · 2023-12-20T14:37:48Z

Can you provide a detailed explanation of how offline mode works with act runner?

BTW, if you cannot access github.com, you can handle it with use: https://custom_domain/some/actions, like https://gitea.com/actions/checkout, it's supported by act runner.

Yes, I created a new pull request at act_runner#454
This code is very limited.

TKaxv-7S · 2023-12-20T14:50:23Z

My plans to create a new ActionCache for nektos/act was rejected silently by all members of nektos/act, by not commenting at all

That would also have an easy offline mode, even with remote action overrides to a local folder of your choice.

I'm sorry for your experience. I only added very few features, and you did more, but I don't have the ability to help you :(

ChristopherHX · 2024-01-08T16:54:06Z

No progress here? You would need two approvals for getting this merged.

FYI My approval for this depends on the following

In nektos act is forcepull enabled by default, I would expect that offline mode would also stop pulling existing images e.g. turning the default force-pull off.

Alternatively I think it might be reasonable that everywhere the forcepull is checked a extra check to OfflineMode is done to behave like forcepull is disabled if OfflineMode is active.

e.g.

if forcepull {
}
if !forcepull {
}

becomes

if !OfflineMode && forcepull {
}
if OfflineMode || !forcepull {
}

I'm not requesting changes in the hard way, so that two other maintainer can still vote to get this merged as it is

I couldn't find the related issue about running act offline, but I believe it exists

TKaxv-7S · 2024-01-09T01:11:37Z

No progress here? You would need two approvals for getting this merged.

FYI My approval for this depends on the following

In nektos act is forcepull enabled by default, I would expect that offline mode would also stop pulling existing images e.g. turning the default force-pull off.

Alternatively I think it might be reasonable that everywhere the forcepull is checked a extra check to OfflineMode is done to behave like forcepull is disabled if OfflineMode is active.

e.g.
if forcepull {
}
if !forcepull {
}
becomes
if !OfflineMode && forcepull {
}
if OfflineMode || !forcepull {
}
I'm not requesting changes in the hard way, so that two other maintainer can still vote to get this merged as it is

I couldn't find the related issue about running act offline, but I believe it exists

I agree with this suggestion. I have modified the code and committed it here

ChristopherHX

Seems like you understood the opposite of what I actually meant.

You are also seem to missing a line here:

act/cmd/root.go

Line 59 in 106275b

    
           rootCmd.Flags().BoolVarP(&input.forcePull, "pull", "p", true, "pull docker image(s) even if already present")

for your cli flag

So what you seem to have changed makes the following
act --offline-mode (act --offline-mode --pull=true) ignore offline mode. (forcepull has default value true in act)

A user of act would have to write
act --offline-mode --pull=false to get the offline mode.

What I meant is
act --offline-mode (act --offline-mode --pull=true) turns on offline mode and turns off force pull.

ChristopherHX · 2024-01-09T04:25:57Z

pkg/runner/reusable_workflow.go

@@ -66,7 +66,7 @@ func cloneIfRequired(rc *RunContext, remoteReusableWorkflow remoteReusableWorkfl
 				Ref:         remoteReusableWorkflow.Ref,
 				Dir:         targetDirectory,
 				Token:       rc.Config.Token,
-				OfflineMode: rc.Config.ActionOfflineMode,


I actually meant to keep this, like it was before

ChristopherHX · 2024-01-09T04:26:18Z

pkg/runner/step_action_remote.go

@@ -67,7 +67,7 @@ func (sar *stepActionRemote) prepareActionExecutor() common.Executor {
 			Ref:         sar.remoteAction.Ref,
 			Dir:         actionDir,
 			Token:       github.Token,
-			OfflineMode: sar.RunContext.Config.ActionOfflineMode,


I actually meant to keep this, like it was before

ChristopherHX · 2024-01-09T04:57:55Z

The lines I meant would be

act/pkg/runner/action.go

Line 231 in adbe229

forcePull = rc.Config.ForcePull
act/pkg/runner/run_context.go

Line 400 in adbe229

rc.pullServicesImages(rc.Config.ForcePull),
act/pkg/runner/run_context.go

Line 401 in adbe229

rc.JobContainer.Pull(rc.Config.ForcePull),
act/pkg/runner/step_docker.go

Line 78 in adbe229

stepContainer.Pull(rc.Config.ForcePull),

So that the offline mode can turn off forcepull.

TKaxv-7S · 2024-01-09T09:19:47Z

@ChristopherHX Sorry for misunderstanding your meaning earlier. Now I have modified the code and committed it here.

ChristopherHX

Works perfectly fine for me on windows, thank you.

Can rerun act with offlinemode using it's cache without getting any error due to turning off internet.

.\t\.github\workflows\t.yaml

on: push
jobs:
  _:
    runs-on: t
    steps:
    - uses: actions/download-artifact@v4 # This actions obviously fails, but never due to no internet

via cli

.\act.exe -C .\t\ -P t=-self-hosted --action-offline-mode

Once the mode is enabled the following is the new behavior

not yet cloned actions will be cloned in this mode, assumes internet is working
already cloned actions won't be updated (breaks updates of rolling tags / branches, but that's a user decision)
already pulled images won't be updated
works offline, with disabled internet
- no rewriting of workflow files needed

One pending review, from maintainers, required...

codecov · 2024-01-09T11:55:36Z

Codecov Report

Attention: 1019 lines in your changes are missing coverage. Please review.

Comparison is base (4989f44) 61.22% compared to head (da0191e) 60.78%.
Report is 299 commits behind head on master.

Files	Patch %	Lines
pkg/artifactcache/handler.go	65.46%	102 Missing and 42 partials ⚠️
pkg/runner/run_context.go	73.37%	75 Missing and 19 partials ⚠️
pkg/runner/expression.go	55.17%	66 Missing and 12 partials ⚠️
pkg/runner/action_cache.go	50.74%	49 Missing and 17 partials ⚠️
pkg/container/docker_run.go	1.51%	64 Missing and 1 partial ⚠️
pkg/container/docker_network.go	0.00%	56 Missing ⚠️
pkg/model/planner.go	28.57%	53 Missing and 2 partials ⚠️
pkg/runner/reusable_workflow.go	52.47%	42 Missing and 6 partials ⚠️
pkg/model/workflow.go	43.37%	40 Missing and 7 partials ⚠️
pkg/common/outbound_ip.go	0.00%	44 Missing ⚠️
... and 27 more

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #2128      +/-   ##
==========================================
- Coverage   61.22%   60.78%   -0.44%     
==========================================
  Files          46       53       +7     
  Lines        7141     8966    +1825     
==========================================
+ Hits         4372     5450    +1078     
- Misses       2462     3079     +617     
- Partials      307      437     +130

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

TKaxv-7S · 2024-01-09T13:08:31Z

Works perfectly fine for me on windows, thank you.

Can rerun act with offlinemode using it's cache without getting any error due to turning off internet.

.\t\.github\workflows\t.yaml
on: push
jobs:
  _:
    runs-on: t
    steps:
    - uses: actions/download-artifact@v4 # This actions obviously fails, but never due to no internet
via cli
.\act.exe -C .\t\ -P t=-self-hosted --action-offline-mode
Once the mode is enabled the following is the new behavior

not yet cloned actions will be cloned in this mode, assumes internet is working

already cloned actions won't be updated (breaks updates of rolling tags / branches, but that's a user decision)

already pulled images won't be updated

works offline, with disabled internet

no rewriting of workflow files needed

One pending review, from maintainers, required...

Thank you for your detailed description of this feature, which makes the originally vague function clearer and easier to understand

* Add: Actions Offline Mode * Add: Actions Offline Mode --------- Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>

Add: Actions Offline Mode

c08a3d2

TKaxv-7S requested a review from a team as a code owner December 16, 2023 04:49

pull-request-size bot added the size/M label Dec 16, 2023

Merge branch 'master' into support_offline_mode

638219f

Merge branch 'master' into support_offline_mode

69e9530

Merge branch 'master' into support_offline_mode

ef9c5db

Merge branch 'master' into support_offline_mode

857d9ce

ChristopherHX reviewed Jan 9, 2024

View reviewed changes

Add: Actions Offline Mode

fe28097

TKaxv-7S force-pushed the support_offline_mode branch from 106275b to fe28097 Compare January 9, 2024 09:16

ChristopherHX approved these changes Jan 9, 2024

View reviewed changes

cplee approved these changes Jan 19, 2024

View reviewed changes

Merge branch 'master' into support_offline_mode

da0191e

mergify bot merged commit f055d4a into nektos:master Jan 20, 2024
10 checks passed

jmikedupont2 pushed a commit to meta-introspector/act that referenced this pull request Mar 10, 2024

feat: support offline mode (nektos#2128)

eac7d37

* Add: Actions Offline Mode * Add: Actions Offline Mode --------- Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: support offline mode #2128

feat: support offline mode #2128

TKaxv-7S commented Dec 16, 2023

wolfogre commented Dec 20, 2023

ChristopherHX commented Dec 20, 2023 •

edited

Loading

ChristopherHX commented Dec 20, 2023

TKaxv-7S commented Dec 20, 2023

TKaxv-7S commented Dec 20, 2023

ChristopherHX commented Jan 8, 2024 •

edited

Loading

TKaxv-7S commented Jan 9, 2024

ChristopherHX left a comment

ChristopherHX Jan 9, 2024

ChristopherHX Jan 9, 2024

ChristopherHX commented Jan 9, 2024

TKaxv-7S commented Jan 9, 2024

ChristopherHX left a comment •

edited

Loading

codecov bot commented Jan 9, 2024 •

edited

Loading

TKaxv-7S commented Jan 9, 2024

feat: support offline mode #2128

feat: support offline mode #2128

Conversation

TKaxv-7S commented Dec 16, 2023

wolfogre commented Dec 20, 2023

ChristopherHX commented Dec 20, 2023 • edited Loading

ChristopherHX commented Dec 20, 2023

TKaxv-7S commented Dec 20, 2023

TKaxv-7S commented Dec 20, 2023

ChristopherHX commented Jan 8, 2024 • edited Loading

TKaxv-7S commented Jan 9, 2024

ChristopherHX left a comment

Choose a reason for hiding this comment

ChristopherHX Jan 9, 2024

Choose a reason for hiding this comment

ChristopherHX Jan 9, 2024

Choose a reason for hiding this comment

ChristopherHX commented Jan 9, 2024

TKaxv-7S commented Jan 9, 2024

ChristopherHX left a comment • edited Loading

Choose a reason for hiding this comment

codecov bot commented Jan 9, 2024 • edited Loading

Codecov Report

TKaxv-7S commented Jan 9, 2024

ChristopherHX commented Dec 20, 2023 •

edited

Loading

ChristopherHX commented Jan 8, 2024 •

edited

Loading

ChristopherHX left a comment •

edited

Loading

codecov bot commented Jan 9, 2024 •

edited

Loading