forked from fluxcd/flux
-
Notifications
You must be signed in to change notification settings - Fork 0
/
working.go
196 lines (170 loc) · 5.04 KB
/
working.go
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
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
package git
import (
"context"
"errors"
"os"
"path/filepath"
)
var (
ErrReadOnly = errors.New("cannot make a working clone of a read-only git repo")
)
// Config holds some values we use when working in the working clone of
// a repo.
type Config struct {
Branch string // branch we're syncing to
Paths []string // paths within the repo containing files we care about
NotesRef string
UserName string
UserEmail string
SigningKey string
SetAuthor bool
SkipMessage string
}
// Checkout is a local working clone of the remote repo. It is
// intended to be used for one-off "transactions", e.g,. committing
// changes then pushing upstream. It has no locking.
type Checkout struct {
*Export
config Config
upstream Remote
realNotesRef string // cache the notes ref, since we use it to push as well
}
type Commit struct {
Signature Signature
Revision string
Message string
}
// CommitAction is a struct holding commit information
type CommitAction struct {
Author string
Message string
SigningKey string
}
// TagAction is a struct holding tag parameters
type TagAction struct {
Tag string
Revision string
Message string
SigningKey string
}
// Clone returns a local working clone of the sync'ed `*Repo`, using
// the config given.
func (r *Repo) Clone(ctx context.Context, conf Config) (*Checkout, error) {
if r.readonly {
return nil, ErrReadOnly
}
upstream := r.Origin()
repoDir, err := r.workingClone(ctx, conf.Branch)
if err != nil {
return nil, err
}
if err := config(ctx, repoDir, conf.UserName, conf.UserEmail); err != nil {
os.RemoveAll(repoDir)
return nil, err
}
// We'll need the notes ref for pushing it, so make sure we have
// it. This assumes we're syncing it (otherwise we'll likely get conflicts)
realNotesRef, err := getNotesRef(ctx, repoDir, conf.NotesRef)
if err != nil {
os.RemoveAll(repoDir)
return nil, err
}
r.mu.RLock()
// Here is where we mimic `git fetch --tags --force`, but
// _without_ overwriting head refs. This is only required for a
// `Checkout` and _not_ for `Repo` as (bare) mirrors will happily
// accept any ref changes to tags.
//
// NB: do this before any other fetch actions, as otherwise we may
// get an 'existing tag clobber' error back.
if err := fetch(ctx, repoDir, r.dir, `'+refs/tags/*:refs/tags/*'`); err != nil {
os.RemoveAll(repoDir)
r.mu.RUnlock()
return nil, err
}
if err := fetch(ctx, repoDir, r.dir, realNotesRef+":"+realNotesRef); err != nil {
os.RemoveAll(repoDir)
r.mu.RUnlock()
return nil, err
}
r.mu.RUnlock()
return &Checkout{
Export: &Export{dir: repoDir},
upstream: upstream,
realNotesRef: realNotesRef,
config: conf,
}, nil
}
// MakeAbsolutePaths returns the absolute path for each of the
// relativePaths given, taking the repo's location as the base.
func MakeAbsolutePaths(r interface{ Dir() string }, relativePaths []string) []string {
if len(relativePaths) == 0 {
return []string{r.Dir()}
}
base := r.Dir()
paths := make([]string, len(relativePaths), len(relativePaths))
for i, p := range relativePaths {
paths[i] = filepath.Join(base, p)
}
return paths
}
// AbsolutePaths returns the absolute paths as configured. It ensures
// that at least one path is returned, so that it can be used with
// `Manifest.LoadManifests`.
func (c *Checkout) AbsolutePaths() []string {
return MakeAbsolutePaths(c, c.config.Paths)
}
// CommitAndPush commits changes made in this checkout, along with any
// extra data as a note, and pushes the commit and note to the remote repo.
func (c *Checkout) CommitAndPush(ctx context.Context, commitAction CommitAction, note interface{}, addUntracked bool) error {
if addUntracked {
if err := add(ctx, c.Dir(), "."); err != nil {
return err
}
}
if !check(ctx, c.Dir(), c.config.Paths, addUntracked) {
return ErrNoChanges
}
commitAction.Message += c.config.SkipMessage
if commitAction.SigningKey == "" {
commitAction.SigningKey = c.config.SigningKey
}
if err := commit(ctx, c.Dir(), commitAction); err != nil {
return err
}
if note != nil {
rev, err := c.HeadRevision(ctx)
if err != nil {
return err
}
if err := addNote(ctx, c.Dir(), rev, c.realNotesRef, note); err != nil {
return err
}
}
refs := []string{c.config.Branch}
ok, err := refExists(ctx, c.Dir(), c.realNotesRef)
if ok {
refs = append(refs, c.realNotesRef)
} else if err != nil {
return err
}
if err := push(ctx, c.Dir(), c.upstream.URL, refs); err != nil {
return PushError(c.upstream.URL, err)
}
return nil
}
func (c *Checkout) HeadRevision(ctx context.Context) (string, error) {
return refRevision(ctx, c.Dir(), "HEAD")
}
func (c *Checkout) MoveTagAndPush(ctx context.Context, tagAction TagAction) error {
if tagAction.SigningKey == "" {
tagAction.SigningKey = c.config.SigningKey
}
return moveTagAndPush(ctx, c.Dir(), c.upstream.URL, tagAction)
}
func (c *Checkout) Checkout(ctx context.Context, rev string) error {
return checkout(ctx, c.Dir(), rev)
}
func (c *Checkout) Add(ctx context.Context, path string) error {
return add(ctx, c.Dir(), path)
}