refactor: pass github context by value

... to avoid side effects on passed values to each other
aweris · Jul 13, 2023 · 1305fab · 1305fab
1 parent 58c8234
commit 1305fab
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 10 deletions.
diff --git a/internal/model/github_context.go b/internal/model/github_context.go
@@ -178,9 +178,9 @@ type GithubContext struct {
 }
 
 // NewGithubContextFromEnv creates a new GithubContext from environment variables.
-func NewGithubContextFromEnv() *GithubContext {
+func NewGithubContextFromEnv() GithubContext {
  //nolint:goconst // keeping "true" here as string makes it easier to read and understand. No need to create a const.
- return &GithubContext{
+ return GithubContext{
  CI: os.Getenv("CI") == "true",
  Actions: os.Getenv("GITHUB_ACTIONS") == "true",
  Action: os.Getenv("GITHUB_ACTION"),
@@ -221,7 +221,7 @@ func NewGithubContextFromEnv() *GithubContext {
 
 // ToEnv converts the GithubContext to a map of environment variables.
 // More info: https://docs.github.com/en/actions/learn-github-actions/variables#default-environment-variables
-func (g *GithubContext) ToEnv() map[string]string {
+func (g GithubContext) ToEnv() map[string]string {
  return map[string]string{
  "CI": strconv.FormatBool(g.CI),
  "GITHUB_ACTION": g.Action,

diff --git a/pkg/gale/exec.go b/pkg/gale/exec.go
@@ -15,7 +15,7 @@ type ExecResult struct {
  Container *dagger.Container
 
  // contexts
- github *model.GithubContext
+ github model.GithubContext
 
  // services
  artifactService *services.ArtifactService

diff --git a/pkg/gale/gale.go b/pkg/gale/gale.go
@@ -40,7 +40,7 @@ type Gale struct {
 
  // contexts
 
- github *model.GithubContext
+ github model.GithubContext
 
  // services
 
@@ -156,7 +156,7 @@ func (g *Gale) loadCurrentRepository() *Gale {
 }
 
 // WithGithubContext sets the github and runner contexts for the gale instance.
-func (g *Gale) WithGithubContext(github *model.GithubContext) *Gale {
+func (g *Gale) WithGithubContext(github model.GithubContext) *Gale {
  return g.WithModifier(func(container *dagger.Container) (*dagger.Container, error) {
  // keep reference to the github context in the gale instance to be able to access it later on.
  g.github = github
@@ -253,7 +253,7 @@ func (g *Gale) Container() (container *dagger.Container, err error) {
 
 // TODO: we should find a better way to get the github contexts. This is a temporary solution.
 
-func getInitialGithubContext() (*model.GithubContext, error) {
+func getInitialGithubContext() (model.GithubContext, error) {
  github := model.NewGithubContextFromEnv()
 
  // if we're running in github actions, we can get the github context from the environment variables.
@@ -264,7 +264,7 @@ func getInitialGithubContext() (*model.GithubContext, error) {
  // update user related information
  user, err := gh.CurrentUser()
  if err != nil {
- return nil, err
+ return model.GithubContext{}, err
  }
 
  github.Actor = user.Login
@@ -274,7 +274,7 @@ func getInitialGithubContext() (*model.GithubContext, error) {
  // update repository related information
  repo, err := gh.CurrentRepository()
  if err != nil {
- return nil, err
+ return model.GithubContext{}, err
  }
 
  github.Repository = repo.NameWithOwner
@@ -287,7 +287,7 @@ func getInitialGithubContext() (*model.GithubContext, error) {
  // update token
  token, err := gh.GetToken()
  if err != nil {
- return nil, err
+ return model.GithubContext{}, err
  }
 
  github.Token = token