feat(hugo): add IsTheme property in returned struct to introduce cust…

…om behaviors depending on hugo themes and hugo sites Signed-off-by: kilianpaquier <[email protected]>
kilianpaquier · Mar 9, 2025 · 7dff8a8 · 7dff8a8
1 parent 0da0c69
commit 7dff8a8
Show file tree

Hide file tree

Showing 11 changed files with 63 additions and 14 deletions.
diff --git a/pkg/craft/generate/templates/_templates/.github/workflows/ci-hugo.part.tmpl b/pkg/craft/generate/templates/_templates/.github/workflows/ci-hugo.part.tmpl
@@ -1,5 +1,6 @@
 jobs:
 <<- define "hugo" >>
+<<- $specifics := get .Languages "hugo" >>
 
   hugo-build:
     name: Hugo Build
@@ -21,7 +22,11 @@ jobs:
         with:
           hugo-version: latest
           extended: true
-      - run: hugo --gc --minify --destination dist
+      - run: |
+<<- if $specifics.IsTheme >>
+          if [ -d exampleSite ]; then cd exampleSite; fi
+<<- end >>
+          hugo --gc --enableGitInfo --minify --destination "${GITHUB_WORKSPACE}/dist"
         env:
           VERSION: ${{ needs.version.outputs.version }}
 <<- if .IsStatic "pages" >>

diff --git a/pkg/craft/generate/templates/_templates/.github/workflows/ci.yml.tmpl b/pkg/craft/generate/templates/_templates/.github/workflows/ci.yml.tmpl
@@ -286,6 +286,9 @@ jobs:
       - id: branch_sha
         run: |
           echo "branch_sha=$(echo "${GITHUB_REF_NAME}" | sha256sum | cut -c -8)" >> $GITHUB_OUTPUT
+      - id: config
+        run: |
+          if [ -f netlify.toml ]; then echo "path=netlify.toml" >> $GITHUB_OUTPUT; fi
       - id: netlify
         uses: nwtgck/actions-netlify@v3
         with:
@@ -295,7 +298,7 @@ jobs:
           enable-commit-status: false
           github-deployment-environment: netlify
           github-token: ${{ secrets.GITHUB_TOKEN }}
-          netlify-config-path: netlify.toml
+          netlify-config-path: ${{ steps.config.outputs.path }}
           production-branch: ${{ github.event.repository.default_branch }}
           publish-dir: dist
         env:

diff --git a/pkg/engine/parser/git.go b/pkg/engine/parser/git.go
@@ -47,7 +47,7 @@ func Git(destdir string) (VCS, error) {
 //   - git.ErrRepositoryNotExists
 //   - git.ErrRemoteNotFound
 func gitOriginURL(destdir string) (string, error) {
-	repository, err := git.PlainOpen(destdir)
+	repository, err := git.PlainOpenWithOptions(destdir, &git.PlainOpenOptions{DetectDotGit: true})
 	if err != nil {
 		return "", fmt.Errorf("open repository: %w", err)
 	}

diff --git a/pkg/engine/parser/golang.go b/pkg/engine/parser/golang.go
@@ -205,7 +205,11 @@ func ReadGoCmd(destdir string) (Executables, error) {
 }
 
 // HugoConfig represents the parse'd hugo.* or theme.* file associated to hugo configuration file.
-type HugoConfig struct{}
+type HugoConfig struct {
+	// IsTheme expresses whether a theme.* configuration is present,
+	// meaning current hugo repository is a theme one.
+	IsTheme bool
+}
 
 // Hugo detects if the project is a Hugo project.
 //
@@ -232,5 +236,8 @@ func Hugo(destdir string) (HugoConfig, bool) {
 	// detect hugo theme
 	themes, _ := filepath.Glob(filepath.Join(destdir, "theme.*"))
 
-	return HugoConfig{}, len(configs) > 0 || len(themes) > 0
+	if len(configs) == 0 && len(themes) == 0 {
+		return HugoConfig{}, false
+	}
+	return HugoConfig{IsTheme: len(themes) > 0}, true
 }
diff --git a/pkg/engine/parser/golang_test.go b/pkg/engine/parser/golang_test.go
@@ -153,7 +153,25 @@ func TestHugo(t *testing.T) {
 		require.NoError(t, err)
 		t.Cleanup(func() { assert.NoError(t, hugo.Close()) })
 
-		expected := parser.HugoConfig{}
+		expected := parser.HugoConfig{IsTheme: false}
+
+		// Act
+		config, ok := parser.Hugo(destdir)
+
+		// Assert
+		assert.True(t, ok)
+		assert.Equal(t, expected, config)
+	})
+
+	t.Run("detected_hugo_theme", func(t *testing.T) {
+		// Arrange
+		destdir := t.TempDir()
+
+		hugo, err := os.Create(filepath.Join(destdir, "theme.toml"))
+		require.NoError(t, err)
+		t.Cleanup(func() { assert.NoError(t, hugo.Close()) })
+
+		expected := parser.HugoConfig{IsTheme: true}
 
 		// Act
 		config, ok := parser.Hugo(destdir)

diff --git a/testdata/TestGenerate_Hugo/github_netlify_auto_false/.github/workflows/ci.yml b/testdata/TestGenerate_Hugo/github_netlify_auto_false/.github/workflows/ci.yml
@@ -97,7 +97,8 @@ jobs:
         with:
           hugo-version: latest
           extended: true
-      - run: hugo --gc --minify --destination dist
+      - run: |
+          hugo --gc --enableGitInfo --minify --destination "${GITHUB_WORKSPACE}/dist"
         env:
           VERSION: ${{ needs.version.outputs.version }}
       - uses: actions/upload-artifact@v4
@@ -128,6 +129,9 @@ jobs:
       - id: branch_sha
         run: |
           echo "branch_sha=$(echo "${GITHUB_REF_NAME}" | sha256sum | cut -c -8)" >> $GITHUB_OUTPUT
+      - id: config
+        run: |
+          if [ -f netlify.toml ]; then echo "path=netlify.toml" >> $GITHUB_OUTPUT; fi
       - id: netlify
         uses: nwtgck/actions-netlify@v3
         with:
@@ -137,7 +141,7 @@ jobs:
           enable-commit-status: false
           github-deployment-environment: netlify
           github-token: ${{ secrets.GITHUB_TOKEN }}
-          netlify-config-path: netlify.toml
+          netlify-config-path: ${{ steps.config.outputs.path }}
           production-branch: ${{ github.event.repository.default_branch }}
           publish-dir: dist
         env:

diff --git a/testdata/TestGenerate_Hugo/github_netlify_auto_true/.github/workflows/ci.yml b/testdata/TestGenerate_Hugo/github_netlify_auto_true/.github/workflows/ci.yml
@@ -97,7 +97,8 @@ jobs:
         with:
           hugo-version: latest
           extended: true
-      - run: hugo --gc --minify --destination dist
+      - run: |
+          hugo --gc --enableGitInfo --minify --destination "${GITHUB_WORKSPACE}/dist"
         env:
           VERSION: ${{ needs.version.outputs.version }}
       - uses: actions/upload-artifact@v4
@@ -128,6 +129,9 @@ jobs:
       - id: branch_sha
         run: |
           echo "branch_sha=$(echo "${GITHUB_REF_NAME}" | sha256sum | cut -c -8)" >> $GITHUB_OUTPUT
+      - id: config
+        run: |
+          if [ -f netlify.toml ]; then echo "path=netlify.toml" >> $GITHUB_OUTPUT; fi
       - id: netlify
         uses: nwtgck/actions-netlify@v3
         with:
@@ -137,7 +141,7 @@ jobs:
           enable-commit-status: false
           github-deployment-environment: netlify
           github-token: ${{ secrets.GITHUB_TOKEN }}
-          netlify-config-path: netlify.toml
+          netlify-config-path: ${{ steps.config.outputs.path }}
           production-branch: ${{ github.event.repository.default_branch }}
           publish-dir: dist
         env:

diff --git a/testdata/TestGenerate_Hugo/github_pages_auto_false/.github/workflows/ci.yml b/testdata/TestGenerate_Hugo/github_pages_auto_false/.github/workflows/ci.yml
@@ -97,7 +97,8 @@ jobs:
         with:
           hugo-version: latest
           extended: true
-      - run: hugo --gc --minify --destination dist
+      - run: |
+          hugo --gc --enableGitInfo --minify --destination "${GITHUB_WORKSPACE}/dist"
         env:
           VERSION: ${{ needs.version.outputs.version }}
       - uses: actions/upload-pages-artifact@v3

diff --git a/testdata/TestGenerate_Hugo/github_pages_auto_true/.github/workflows/ci.yml b/testdata/TestGenerate_Hugo/github_pages_auto_true/.github/workflows/ci.yml
@@ -97,7 +97,8 @@ jobs:
         with:
           hugo-version: latest
           extended: true
-      - run: hugo --gc --minify --destination dist
+      - run: |
+          hugo --gc --enableGitInfo --minify --destination "${GITHUB_WORKSPACE}/dist"
         env:
           VERSION: ${{ needs.version.outputs.version }}
       - uses: actions/upload-pages-artifact@v3

diff --git a/testdata/TestGenerate_Node/success_static/github_netlify_auto_false/.github/workflows/ci.yml b/testdata/TestGenerate_Node/success_static/github_netlify_auto_false/.github/workflows/ci.yml
@@ -154,6 +154,9 @@ jobs:
       - id: branch_sha
         run: |
           echo "branch_sha=$(echo "${GITHUB_REF_NAME}" | sha256sum | cut -c -8)" >> $GITHUB_OUTPUT
+      - id: config
+        run: |
+          if [ -f netlify.toml ]; then echo "path=netlify.toml" >> $GITHUB_OUTPUT; fi
       - id: netlify
         uses: nwtgck/actions-netlify@v3
         with:
@@ -163,7 +166,7 @@ jobs:
           enable-commit-status: false
           github-deployment-environment: netlify
           github-token: ${{ secrets.GITHUB_TOKEN }}
-          netlify-config-path: netlify.toml
+          netlify-config-path: ${{ steps.config.outputs.path }}
           production-branch: ${{ github.event.repository.default_branch }}
           publish-dir: dist
         env:

diff --git a/testdata/TestGenerate_Node/success_static/github_netlify_auto_true/.github/workflows/ci.yml b/testdata/TestGenerate_Node/success_static/github_netlify_auto_true/.github/workflows/ci.yml
@@ -154,6 +154,9 @@ jobs:
       - id: branch_sha
         run: |
           echo "branch_sha=$(echo "${GITHUB_REF_NAME}" | sha256sum | cut -c -8)" >> $GITHUB_OUTPUT
+      - id: config
+        run: |
+          if [ -f netlify.toml ]; then echo "path=netlify.toml" >> $GITHUB_OUTPUT; fi
       - id: netlify
         uses: nwtgck/actions-netlify@v3
         with:
@@ -163,7 +166,7 @@ jobs:
           enable-commit-status: false
           github-deployment-environment: netlify
           github-token: ${{ secrets.GITHUB_TOKEN }}
-          netlify-config-path: netlify.toml
+          netlify-config-path: ${{ steps.config.outputs.path }}
           production-branch: ${{ github.event.repository.default_branch }}
           publish-dir: dist
         env: