aboutsummaryrefslogtreecommitdiffstats
path: root/models
diff options
context:
space:
mode:
authorsillyguodong <33891828+sillyguodong@users.noreply.github.com>2023-06-21 06:54:15 +0800
committerGitHub <noreply@github.com>2023-06-20 22:54:15 +0000
commit35a653d7edbe0d693649604b8309bfc578dd988b (patch)
treed804f5341067234c2d286b5f07b5ad839f4ead52 /models
parent8220e50b56cf7bf9cdfff29a287c5721c3949464 (diff)
downloadgitea-35a653d7edbe0d693649604b8309bfc578dd988b.tar.gz
gitea-35a653d7edbe0d693649604b8309bfc578dd988b.zip
Support configuration variables on Gitea Actions (#24724)
Co-Author: @silverwind @wxiaoguang Replace: #24404 See: - [defining configuration variables for multiple workflows](https://docs.github.com/en/actions/learn-github-actions/variables#defining-configuration-variables-for-multiple-workflows) - [vars context](https://docs.github.com/en/actions/learn-github-actions/contexts#vars-context) Related to: - [x] protocol: https://gitea.com/gitea/actions-proto-def/pulls/7 - [x] act_runner: https://gitea.com/gitea/act_runner/pulls/157 - [x] act: https://gitea.com/gitea/act/pulls/43 #### Screenshoot Create Variable: ![image](https://user-images.githubusercontent.com/33891828/236758288-032b7f64-44e7-48ea-b07d-de8b8b0e3729.png) ![image](https://user-images.githubusercontent.com/33891828/236758174-5203f64c-1d0e-4737-a5b0-62061dee86f8.png) Workflow: ```yaml test_vars: runs-on: ubuntu-latest steps: - name: Print Custom Variables run: echo "${{ vars.test_key }}" - name: Try to print a non-exist var run: echo "${{ vars.NON_EXIST_VAR }}" ``` Actions Log: ![image](https://user-images.githubusercontent.com/33891828/236759075-af0c5950-368d-4758-a8ac-47a96e43b6e2.png) --- This PR just implement the org / user (depends on the owner of the current repository) and repo level variables, The Environment level variables have not been implemented. Because [Environment](https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment#about-environments) is a module separate from `Actions`. Maybe it would be better to create a new PR to do it. --------- Co-authored-by: silverwind <me@silverwind.io> Co-authored-by: wxiaoguang <wxiaoguang@gmail.com> Co-authored-by: Giteabot <teabot@gitea.io>
Diffstat (limited to 'models')
-rw-r--r--models/actions/variable.go97
-rw-r--r--models/migrations/migrations.go3
-rw-r--r--models/migrations/v1_21/v261.go24
-rw-r--r--models/secret/secret.go42
4 files changed, 128 insertions, 38 deletions
diff --git a/models/actions/variable.go b/models/actions/variable.go
new file mode 100644
index 0000000000..e0bb59ccbe
--- /dev/null
+++ b/models/actions/variable.go
@@ -0,0 +1,97 @@
+// Copyright 2023 The Gitea Authors. All rights reserved.
+// SPDX-License-Identifier: MIT
+
+package actions
+
+import (
+ "context"
+ "errors"
+ "fmt"
+ "strings"
+
+ "code.gitea.io/gitea/models/db"
+ "code.gitea.io/gitea/modules/timeutil"
+ "code.gitea.io/gitea/modules/util"
+
+ "xorm.io/builder"
+)
+
+type ActionVariable struct {
+ ID int64 `xorm:"pk autoincr"`
+ OwnerID int64 `xorm:"UNIQUE(owner_repo_name)"`
+ RepoID int64 `xorm:"INDEX UNIQUE(owner_repo_name)"`
+ Name string `xorm:"UNIQUE(owner_repo_name) NOT NULL"`
+ Data string `xorm:"LONGTEXT NOT NULL"`
+ CreatedUnix timeutil.TimeStamp `xorm:"created NOT NULL"`
+ UpdatedUnix timeutil.TimeStamp `xorm:"updated"`
+}
+
+func init() {
+ db.RegisterModel(new(ActionVariable))
+}
+
+func (v *ActionVariable) Validate() error {
+ if v.OwnerID == 0 && v.RepoID == 0 {
+ return errors.New("the variable is not bound to any scope")
+ }
+ return nil
+}
+
+func InsertVariable(ctx context.Context, ownerID, repoID int64, name, data string) (*ActionVariable, error) {
+ variable := &ActionVariable{
+ OwnerID: ownerID,
+ RepoID: repoID,
+ Name: strings.ToUpper(name),
+ Data: data,
+ }
+ if err := variable.Validate(); err != nil {
+ return variable, err
+ }
+ return variable, db.Insert(ctx, variable)
+}
+
+type FindVariablesOpts struct {
+ db.ListOptions
+ OwnerID int64
+ RepoID int64
+}
+
+func (opts *FindVariablesOpts) toConds() builder.Cond {
+ cond := builder.NewCond()
+ if opts.OwnerID > 0 {
+ cond = cond.And(builder.Eq{"owner_id": opts.OwnerID})
+ }
+ if opts.RepoID > 0 {
+ cond = cond.And(builder.Eq{"repo_id": opts.RepoID})
+ }
+ return cond
+}
+
+func FindVariables(ctx context.Context, opts FindVariablesOpts) ([]*ActionVariable, error) {
+ var variables []*ActionVariable
+ sess := db.GetEngine(ctx)
+ if opts.PageSize != 0 {
+ sess = db.SetSessionPagination(sess, &opts.ListOptions)
+ }
+ return variables, sess.Where(opts.toConds()).Find(&variables)
+}
+
+func GetVariableByID(ctx context.Context, variableID int64) (*ActionVariable, error) {
+ var variable ActionVariable
+ has, err := db.GetEngine(ctx).Where("id=?", variableID).Get(&variable)
+ if err != nil {
+ return nil, err
+ } else if !has {
+ return nil, fmt.Errorf("variable with id %d: %w", variableID, util.ErrNotExist)
+ }
+ return &variable, nil
+}
+
+func UpdateVariable(ctx context.Context, variable *ActionVariable) (bool, error) {
+ count, err := db.GetEngine(ctx).ID(variable.ID).Cols("name", "data").
+ Update(&ActionVariable{
+ Name: variable.Name,
+ Data: variable.Data,
+ })
+ return count != 0, err
+}
diff --git a/models/migrations/migrations.go b/models/migrations/migrations.go
index 4eb512ab49..1d443b3d15 100644
--- a/models/migrations/migrations.go
+++ b/models/migrations/migrations.go
@@ -503,6 +503,9 @@ var migrations = []Migration{
// v260 -> v261
NewMigration("Drop custom_labels column of action_runner table", v1_21.DropCustomLabelsColumnOfActionRunner),
+
+ // v261 -> v262
+ NewMigration("Add variable table", v1_21.CreateVariableTable),
}
// GetCurrentDBVersion returns the current db version
diff --git a/models/migrations/v1_21/v261.go b/models/migrations/v1_21/v261.go
new file mode 100644
index 0000000000..4ec1160d0b
--- /dev/null
+++ b/models/migrations/v1_21/v261.go
@@ -0,0 +1,24 @@
+// Copyright 2023 The Gitea Authors. All rights reserved.
+// SPDX-License-Identifier: MIT
+
+package v1_21 //nolint
+
+import (
+ "code.gitea.io/gitea/modules/timeutil"
+
+ "xorm.io/xorm"
+)
+
+func CreateVariableTable(x *xorm.Engine) error {
+ type ActionVariable struct {
+ ID int64 `xorm:"pk autoincr"`
+ OwnerID int64 `xorm:"UNIQUE(owner_repo_name)"`
+ RepoID int64 `xorm:"INDEX UNIQUE(owner_repo_name)"`
+ Name string `xorm:"UNIQUE(owner_repo_name) NOT NULL"`
+ Data string `xorm:"LONGTEXT NOT NULL"`
+ CreatedUnix timeutil.TimeStamp `xorm:"created NOT NULL"`
+ UpdatedUnix timeutil.TimeStamp `xorm:"updated"`
+ }
+
+ return x.Sync(new(ActionVariable))
+}
diff --git a/models/secret/secret.go b/models/secret/secret.go
index 8b23b6c35c..5a17cc37a5 100644
--- a/models/secret/secret.go
+++ b/models/secret/secret.go
@@ -5,38 +5,17 @@ package secret
import (
"context"
- "fmt"
- "regexp"
+ "errors"
"strings"
"code.gitea.io/gitea/models/db"
secret_module "code.gitea.io/gitea/modules/secret"
"code.gitea.io/gitea/modules/setting"
"code.gitea.io/gitea/modules/timeutil"
- "code.gitea.io/gitea/modules/util"
"xorm.io/builder"
)
-type ErrSecretInvalidValue struct {
- Name *string
- Data *string
-}
-
-func (err ErrSecretInvalidValue) Error() string {
- if err.Name != nil {
- return fmt.Sprintf("secret name %q is invalid", *err.Name)
- }
- if err.Data != nil {
- return fmt.Sprintf("secret data %q is invalid", *err.Data)
- }
- return util.ErrInvalidArgument.Error()
-}
-
-func (err ErrSecretInvalidValue) Unwrap() error {
- return util.ErrInvalidArgument
-}
-
// Secret represents a secret
type Secret struct {
ID int64
@@ -74,24 +53,11 @@ func init() {
db.RegisterModel(new(Secret))
}
-var (
- secretNameReg = regexp.MustCompile("^[A-Z_][A-Z0-9_]*$")
- forbiddenSecretPrefixReg = regexp.MustCompile("^GIT(EA|HUB)_")
-)
-
-// Validate validates the required fields and formats.
func (s *Secret) Validate() error {
- switch {
- case len(s.Name) == 0 || len(s.Name) > 50:
- return ErrSecretInvalidValue{Name: &s.Name}
- case len(s.Data) == 0:
- return ErrSecretInvalidValue{Data: &s.Data}
- case !secretNameReg.MatchString(s.Name) ||
- forbiddenSecretPrefixReg.MatchString(s.Name):
- return ErrSecretInvalidValue{Name: &s.Name}
- default:
- return nil
+ if s.OwnerID == 0 && s.RepoID == 0 {
+ return errors.New("the secret is not bound to any scope")
}
+ return nil
}
type FindSecretsOptions struct {