diff --git a/custom/conf/app.example.ini b/custom/conf/app.example.ini index f0b0cc298b..d3e2cba515 100644 --- a/custom/conf/app.example.ini +++ b/custom/conf/app.example.ini @@ -2563,9 +2563,8 @@ LEVEL = Info ; [actions] ;; Enable/Disable actions capabilities ;ENABLED = false -;; -;; Default platform to get action plugins, `github` for `https://github.com`, `self` for the current Gitea instance. -;DEFAULT_ACTIONS_URL = github +;; Default address to get action plugins, e.g. the default value means downloading from "https://code.forgejo.org/actions/checkout" for "uses: actions/checkout@v3" +;DEFAULT_ACTIONS_URL = https://code.forgejo.org ;; Default artifact retention time in days, default is 90 days ;ARTIFACT_RETENTION_DAYS = 90 diff --git a/docs/content/administration/config-cheat-sheet.en-us.md b/docs/content/administration/config-cheat-sheet.en-us.md index acfb6ce77e..57abed1c73 100644 --- a/docs/content/administration/config-cheat-sheet.en-us.md +++ b/docs/content/administration/config-cheat-sheet.en-us.md @@ -1385,23 +1385,40 @@ PROXY_HOSTS = *.github.com ## Actions (`actions`) - `ENABLED`: **false**: Enable/Disable actions capabilities -- `DEFAULT_ACTIONS_URL`: **github**: Default platform to get action plugins, `github` for `https://github.com`, `self` for the current Gitea instance. +- `DEFAULT_ACTIONS_URL`: **https://gitea.com**: Default address to get action plugins, e.g. the default value means downloading from "" for "uses: actions/checkout@v3" - `STORAGE_TYPE`: **local**: Storage type for actions logs, `local` for local disk or `minio` for s3 compatible object storage service, default is `local` or other name defined with `[storage.xxx]` - `MINIO_BASE_PATH`: **actions_log/**: Minio base path on the bucket only available when STORAGE_TYPE is `minio` - `ARTIFACT_RETENTION_DAYS`: **90**: Number of days to keep artifacts. Set to 0 to disable artifact retention. Default is 90 days if not set. -`DEFAULT_ACTIONS_URL` indicates where the Gitea Actions runners should find the actions with relative path. -For example, `uses: actions/checkout@v3` means `https://github.com/actions/checkout@v3` since the value of `DEFAULT_ACTIONS_URL` is `github`. -And it can be changed to `self` to make it `root_url_of_your_gitea/actions/checkout@v3`. +`DEFAULT_ACTIONS_URL` indicates where should we find the relative path action plugin. i.e. when use an action in a workflow file like -Please note that using `self` is not recommended for most cases, as it could make names globally ambiguous. -Additionally, it requires you to mirror all the actions you need to your Gitea instance, which may not be worth it. -Therefore, please use `self` only if you understand what you are doing. +```yaml +name: versions +on: + push: + branches: + - main + - releases/* +jobs: + build: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 +``` -In earlier versions (<= 1.19), `DEFAULT_ACTIONS_URL` cound be set to any custom URLs like `https://gitea.com` or `http://your-git-server,https://gitea.com`, and the default value was `https://gitea.com`. -However, later updates removed those options, and now the only options are `github` and `self`, with the default value being `github`. -However, if you want to use actions from other git server, you can use a complete URL in `uses` field, it's supported by Gitea (but not GitHub). -Like `uses: https://gitea.com/actions/checkout@v3` or `uses: http://your-git-server/actions/checkout@v3`. +Now we need to know how to get actions/checkout, this configuration is the default git server to get it. That means we will get the repository via git clone ${DEFAULT_ACTIONS_URL}/actions/checkout and fetch tag v3. + +To help people who don't want to mirror these actions in their git instances, the default value is https://gitea.com +To help people run actions totally in their network, they can change the value and copy all necessary action repositories into their git server. + +Of course we should support the form in future PRs like + +```yaml +steps: + - uses: gitea.com/actions/checkout@v3 +``` + +although Github don't support this form. ## Other (`other`) diff --git a/modules/setting/actions.go b/modules/setting/actions.go index bfc502c0cb..403d018b76 100644 --- a/modules/setting/actions.go +++ b/modules/setting/actions.go @@ -6,8 +6,6 @@ package setting import ( "fmt" "strings" - - "code.gitea.io/gitea/modules/log" ) // Actions settings @@ -20,7 +18,7 @@ var ( DefaultActionsURL defaultActionsURL `ini:"DEFAULT_ACTIONS_URL"` }{ Enabled: false, - DefaultActionsURL: defaultActionsURLGitHub, + DefaultActionsURL: defaultActionsURLForgejo, } ) @@ -33,18 +31,14 @@ func (url defaultActionsURL) URL() string { case defaultActionsURLSelf: return strings.TrimSuffix(AppURL, "/") default: - // This should never happen, but just in case, use GitHub as fallback - return "https://github.com" + return string(url) } } const ( - defaultActionsURLGitHub = "github" // https://github.com - defaultActionsURLSelf = "self" // the root URL of the self-hosted Gitea instance - // DefaultActionsURL only supports GitHub and the self-hosted Gitea. - // It's intentionally not supported more, so please be cautious before adding more like "gitea" or "gitlab". - // If you get some trouble with `uses: username/action_name@version` in your workflow, - // please consider to use `uses: https://the_url_you_want_to_use/username/action_name@version` instead. + defaultActionsURLForgejo = "https://code.forgejo.org" + defaultActionsURLGitHub = "github" // https://github.com + defaultActionsURLSelf = "self" // the root URL of the self-hosted instance ) func loadActionsFrom(rootCfg ConfigProvider) error { @@ -54,19 +48,6 @@ func loadActionsFrom(rootCfg ConfigProvider) error { return fmt.Errorf("failed to map Actions settings: %v", err) } - if urls := string(Actions.DefaultActionsURL); urls != defaultActionsURLGitHub && urls != defaultActionsURLSelf { - url := strings.Split(urls, ",")[0] - if strings.HasPrefix(url, "https://") || strings.HasPrefix(url, "http://") { - log.Error("[actions] DEFAULT_ACTIONS_URL does not support %q as custom URL any longer, fallback to %q", - urls, - defaultActionsURLGitHub, - ) - Actions.DefaultActionsURL = defaultActionsURLGitHub - } else { - return fmt.Errorf("unsupported [actions] DEFAULT_ACTIONS_URL: %q", urls) - } - } - // don't support to read configuration from [actions] Actions.LogStorage, err = getStorage(rootCfg, "actions_log", "", nil) if err != nil { diff --git a/modules/setting/actions_test.go b/modules/setting/actions_test.go index 3645a3f5da..01f5bf74a5 100644 --- a/modules/setting/actions_test.go +++ b/modules/setting/actions_test.go @@ -110,7 +110,6 @@ func Test_getDefaultActionsURLForActions(t *testing.T) { tests := []struct { name string iniStr string - wantErr assert.ErrorAssertionFunc wantURL string }{ { @@ -118,8 +117,7 @@ func Test_getDefaultActionsURLForActions(t *testing.T) { iniStr: ` [actions] `, - wantErr: assert.NoError, - wantURL: "https://github.com", + wantURL: "https://code.forgejo.org", }, { name: "github", @@ -127,7 +125,6 @@ func Test_getDefaultActionsURLForActions(t *testing.T) { [actions] DEFAULT_ACTIONS_URL = github `, - wantErr: assert.NoError, wantURL: "https://github.com", }, { @@ -136,35 +133,15 @@ DEFAULT_ACTIONS_URL = github [actions] DEFAULT_ACTIONS_URL = self `, - wantErr: assert.NoError, wantURL: "http://test_get_default_actions_url_for_actions:3000", }, - { - name: "custom url", - iniStr: ` -[actions] -DEFAULT_ACTIONS_URL = https://gitea.com -`, - wantErr: assert.NoError, - wantURL: "https://github.com", - }, { name: "custom urls", iniStr: ` [actions] -DEFAULT_ACTIONS_URL = https://gitea.com,https://github.com +DEFAULT_ACTIONS_URL = https://example.com `, - wantErr: assert.NoError, - wantURL: "https://github.com", - }, - { - name: "invalid", - iniStr: ` -[actions] -DEFAULT_ACTIONS_URL = gitea -`, - wantErr: assert.Error, - wantURL: "https://github.com", + wantURL: "https://example.com", }, } @@ -172,7 +149,7 @@ DEFAULT_ACTIONS_URL = gitea t.Run(tt.name, func(t *testing.T) { cfg, err := NewConfigProviderFromData(tt.iniStr) require.NoError(t, err) - if !tt.wantErr(t, loadActionsFrom(cfg)) { + if !assert.NoError(t, loadActionsFrom(cfg)) { return } assert.EqualValues(t, tt.wantURL, Actions.DefaultActionsURL.URL())