FilesExpand file tree

main

/

ambient_folders.go

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

142 lines (132 loc) · 4.88 KB

main

/

ambient_folders.go

Copy path

Top

File metadata and controls

• Code
• Blame

142 lines (132 loc) · 4.88 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

68

69

70

71

72

73

74

75

76

77

78

79

80

81

82

83

84

85

86

87

88

89

90

91

92

93

94

95

96

97

98

99

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

package workflow

import (

"errors"

"fmt"

"path/filepath"

"regexp"

"strings"

"github.com/github/gh-aw/pkg/constants"

"github.com/github/gh-aw/pkg/logger"

"github.com/github/gh-aw/pkg/parser"

)

var ambientFoldersLog = logger.New("workflow:ambient_folders")

var ambientFolderPattern = regexp.MustCompile(`^[A-Za-z0-9._/-]+$`)

func resolveAmbientFolders(frontmatter map[string]any, importsResult *parser.ImportsResult) ([]string, error) {

var merged []string

if importsResult != nil {

merged = append(merged, importsResult.MergedAmbientFolders...)

ambientFoldersLog.Printf("Merged %d ambient folders from imports", len(importsResult.MergedAmbientFolders))

}

main, err := extractAmbientFolders(frontmatter)

if err != nil {

return nil, err

}

merged = append(merged, main...)

normalized, err := normalizeAmbientFolders(merged)

if err != nil {

return nil, err

}

ambientFoldersLog.Printf("Resolved %d ambient folders", len(normalized))

return normalized, nil

}

func extractAmbientFolders(frontmatter map[string]any) ([]string, error) {

if frontmatter == nil {

return nil, nil

}

raw, exists := frontmatter["ambient-folders"]

if !exists || raw == nil {

return nil, nil

}

values, ok := raw.([]any)

if !ok {

if typed, ok := raw.([]string); ok {

values = make([]any, 0, len(typed))

for _, value := range typed {

values = append(values, value)

}

} else {

return nil, errors.New("ambient-folders has an unsupported type, expected an array of folder path strings. Example: ambient-folders: [docs, src/lib]")

}

}

folders := make([]string, 0, len(values))

for _, value := range values {

folder, ok := value.(string)

if !ok {

return nil, errors.New("ambient-folders entry has an unsupported type, expected a string folder path. Example: ambient-folders: [docs, src/lib]")

}

folders = append(folders, folder)

}

return folders, nil

}

func normalizeAmbientFolders(folders []string) ([]string, error) {

seen := make(map[string]struct{}, len(folders))

normalized := make([]string, 0, len(folders))

for _, folder := range folders {

value := strings.TrimSpace(strings.ReplaceAll(folder, "\\", "/"))

if value == "" {

return nil, errors.New("ambient-folders entry is empty, expected a non-empty relative folder path. Example: ambient-folders: [docs, src/lib]")

}

clean := filepath.ToSlash(filepath.Clean(value))

if clean == "." || clean == ".." || strings.HasPrefix(clean, "../") || filepath.IsAbs(value) || strings.HasPrefix(value, "/") {

return nil, fmt.Errorf("ambient-folders entry %q is not a relative path within the repository, expected a relative folder path without '..' or a leading '/'. Example: ambient-folders: [docs, src/lib]", folder)

}

if !ambientFolderPattern.MatchString(clean) {

return nil, fmt.Errorf("ambient-folders entry %q contains unsupported characters, expected only letters, digits, '.', '_', '-', and '/'. Example: ambient-folders: [docs, src/lib]", folder)

}

if _, exists := seen[clean]; exists {

ambientFoldersLog.Printf("Skipping duplicate ambient folder: %s", clean)

continue

}

seen[clean] = struct{}{}

normalized = append(normalized, clean)

}

return normalized, nil

}

func generateStageAmbientFoldersStep(data *WorkflowData) []string {

if data == nil || len(data.AmbientFolders) == 0 {

return nil

}

folders := strings.Join(data.AmbientFolders, " ")

return []string{

" - name: " + constants.ActivationStageAmbientFoldersStepName + "\n",

" env:\n",

fmt.Sprintf(" GH_AW_AMBIENT_FOLDERS: \"%s\"\n", folders),

" run: |\n",

" mkdir -p /tmp/gh-aw/ambient-folders\n",

" for folder in $GH_AW_AMBIENT_FOLDERS; do\n",

" src=\"$GITHUB_WORKSPACE/$folder\"\n",

" dst=\"/tmp/gh-aw/ambient-folders/$folder\"\n",

" if [ -e \"$src\" ]; then\n",

" mkdir -p \"$(dirname \"$dst\")\"\n",

" rm -rf \"$dst\"\n",

" cp -a \"$src\" \"$dst\"\n",

" fi\n",

" done\n",

}

}

func generateRestoreAmbientFoldersStep(yaml *strings.Builder, data *WorkflowData) {

for _, line := range restoreAmbientFoldersSteps(data) {

yaml.WriteString(line)

yaml.WriteByte('\n')

}

}

func restoreAmbientFoldersSteps(data *WorkflowData) GitHubActionStep {

if data == nil || len(data.AmbientFolders) == 0 {

return nil

}

return GitHubActionStep{

" - name: Restore ambient folders from activation artifact",

" env:",

fmt.Sprintf(" GH_AW_AMBIENT_FOLDERS: \"%s\"", strings.Join(data.AmbientFolders, " ")),

" run: |",

" for folder in $GH_AW_AMBIENT_FOLDERS; do",

" src=\"/tmp/gh-aw/ambient-folders/$folder\"",

" dst=\"$GITHUB_WORKSPACE/$folder\"",

" if [ -e \"$src\" ]; then",

" mkdir -p \"$(dirname \"$dst\")\"",

" rm -rf \"$dst\"",

" cp -a \"$src\" \"$dst\"",

" fi",

" done",

}

}