2020-04-12 11:47:46 -03:00
|
|
|
// Package sourcearchive archives the source of the project using git-archive.
|
|
|
|
package sourcearchive
|
|
|
|
|
|
|
|
import (
|
2022-08-25 02:15:37 -03:00
|
|
|
"fmt"
|
|
|
|
"os"
|
2020-04-12 11:47:46 -03:00
|
|
|
"path/filepath"
|
2022-08-25 02:15:37 -03:00
|
|
|
"strings"
|
2020-04-12 11:47:46 -03:00
|
|
|
|
2022-06-21 21:11:15 -03:00
|
|
|
"github.com/caarlos0/log"
|
2022-08-25 01:10:26 -03:00
|
|
|
"github.com/goreleaser/goreleaser/internal/archivefiles"
|
2020-04-12 11:47:46 -03:00
|
|
|
"github.com/goreleaser/goreleaser/internal/artifact"
|
feat: better archives relative paths (#3656)
with this patch, a config like:
```yaml
archives:
- format: tar.gz
# this name template makes the OS and Arch compatible with the results of uname.
name_template: >-
{{ .ProjectName }}_
{{- title .Os }}_
{{- if eq .Arch "amd64" }}x86_64
{{- else if eq .Arch "386" }}i386
{{- else }}{{ .Arch }}{{ end }}
{{- if .Arm }}v{{ .Arm }}{{ end }}
rlcp: true
files:
- src: "build/**/*"
dst: .
nfpms:
- package_name: foo
contents:
- src: "build/**/*"
dst: usr/share/foo
formats:
- apk
```
will eval this:
<img width="1384" alt="CleanShot 2022-12-21 at 22 21 00@2x"
src="https://user-images.githubusercontent.com/245435/209034244-7c31b5f7-cfcd-4825-bb2f-7dd463c5286a.png">
as much as I would like to make this the default, it would be a breaking
change, so we really can't do it.
If `dst` is empty, it'll have the same behavior as before (no rlcp), and
if `strip_parent` is set, it will also still have the same behavior.
Finally, if the format is binary, `rlcp` is ignored too (as it doesn't
make sense).
So, this only changes if:
- your format is not binary; and
- you have files with `src` and `dst` set
Then, goreleaser will warn you to set `rlcp: true`.
## todo
- [x] docs
- [x] more tests probably
- [x] any ideas for a better name for the new config option?
fixes #3655
Signed-off-by: Carlos A Becker <caarlos0@users.noreply.github.com>
2022-12-27 17:42:55 -03:00
|
|
|
"github.com/goreleaser/goreleaser/internal/deprecate"
|
2020-04-12 11:47:46 -03:00
|
|
|
"github.com/goreleaser/goreleaser/internal/git"
|
|
|
|
"github.com/goreleaser/goreleaser/internal/tmpl"
|
2022-08-25 02:15:37 -03:00
|
|
|
"github.com/goreleaser/goreleaser/pkg/archive"
|
2022-08-25 01:10:26 -03:00
|
|
|
"github.com/goreleaser/goreleaser/pkg/config"
|
2020-04-12 11:47:46 -03:00
|
|
|
"github.com/goreleaser/goreleaser/pkg/context"
|
|
|
|
)
|
|
|
|
|
2020-05-26 00:48:10 -03:00
|
|
|
// Pipe for source archive.
|
2020-04-12 11:47:46 -03:00
|
|
|
type Pipe struct{}
|
|
|
|
|
|
|
|
func (Pipe) String() string {
|
|
|
|
return "creating source archive"
|
|
|
|
}
|
|
|
|
|
2021-09-18 10:21:29 -03:00
|
|
|
func (Pipe) Skip(ctx *context.Context) bool {
|
|
|
|
return !ctx.Config.Source.Enabled
|
|
|
|
}
|
|
|
|
|
2020-05-26 00:48:10 -03:00
|
|
|
// Run the pipe.
|
2020-04-12 11:47:46 -03:00
|
|
|
func (Pipe) Run(ctx *context.Context) (err error) {
|
|
|
|
name, err := tmpl.New(ctx).Apply(ctx.Config.Source.NameTemplate)
|
|
|
|
if err != nil {
|
|
|
|
return err
|
|
|
|
}
|
2021-04-19 09:31:57 -03:00
|
|
|
filename := name + "." + ctx.Config.Source.Format
|
|
|
|
path := filepath.Join(ctx.Config.Dist, filename)
|
2020-04-12 11:47:46 -03:00
|
|
|
log.WithField("file", filename).Info("creating source archive")
|
2022-08-25 02:15:37 -03:00
|
|
|
|
|
|
|
out, err := git.Run(ctx, "ls-files")
|
|
|
|
if err != nil {
|
|
|
|
return fmt.Errorf("could not list source files: %w", err)
|
2021-11-02 23:57:20 +01:00
|
|
|
}
|
2022-08-25 01:10:26 -03:00
|
|
|
|
2022-08-25 02:15:37 -03:00
|
|
|
prefix, err := tmpl.New(ctx).Apply(ctx.Config.Source.PrefixTemplate)
|
|
|
|
if err != nil {
|
|
|
|
return err
|
2021-11-02 23:57:20 +01:00
|
|
|
}
|
2022-08-25 01:10:26 -03:00
|
|
|
|
2022-08-25 02:15:37 -03:00
|
|
|
af, err := os.Create(path)
|
|
|
|
if err != nil {
|
|
|
|
return fmt.Errorf("could not create archive: %w", err)
|
|
|
|
}
|
|
|
|
defer af.Close() //nolint:errcheck
|
|
|
|
|
|
|
|
arch, err := archive.New(af, ctx.Config.Source.Format)
|
|
|
|
if err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
|
|
|
|
var ff []config.File
|
|
|
|
for _, f := range strings.Split(out, "\n") {
|
|
|
|
if strings.TrimSpace(f) == "" {
|
|
|
|
continue
|
|
|
|
}
|
|
|
|
ff = append(ff, config.File{
|
|
|
|
Source: f,
|
|
|
|
})
|
|
|
|
}
|
feat: better archives relative paths (#3656)
with this patch, a config like:
```yaml
archives:
- format: tar.gz
# this name template makes the OS and Arch compatible with the results of uname.
name_template: >-
{{ .ProjectName }}_
{{- title .Os }}_
{{- if eq .Arch "amd64" }}x86_64
{{- else if eq .Arch "386" }}i386
{{- else }}{{ .Arch }}{{ end }}
{{- if .Arm }}v{{ .Arm }}{{ end }}
rlcp: true
files:
- src: "build/**/*"
dst: .
nfpms:
- package_name: foo
contents:
- src: "build/**/*"
dst: usr/share/foo
formats:
- apk
```
will eval this:
<img width="1384" alt="CleanShot 2022-12-21 at 22 21 00@2x"
src="https://user-images.githubusercontent.com/245435/209034244-7c31b5f7-cfcd-4825-bb2f-7dd463c5286a.png">
as much as I would like to make this the default, it would be a breaking
change, so we really can't do it.
If `dst` is empty, it'll have the same behavior as before (no rlcp), and
if `strip_parent` is set, it will also still have the same behavior.
Finally, if the format is binary, `rlcp` is ignored too (as it doesn't
make sense).
So, this only changes if:
- your format is not binary; and
- you have files with `src` and `dst` set
Then, goreleaser will warn you to set `rlcp: true`.
## todo
- [x] docs
- [x] more tests probably
- [x] any ideas for a better name for the new config option?
fixes #3655
Signed-off-by: Carlos A Becker <caarlos0@users.noreply.github.com>
2022-12-27 17:42:55 -03:00
|
|
|
files, err := archivefiles.Eval(
|
|
|
|
tmpl.New(ctx),
|
|
|
|
ctx.Config.Source.RLCP,
|
|
|
|
append(ff, ctx.Config.Source.Files...),
|
|
|
|
)
|
2022-08-25 01:10:26 -03:00
|
|
|
if err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
for _, f := range files {
|
2022-08-25 02:15:37 -03:00
|
|
|
f.Destination = filepath.Join(prefix, f.Destination)
|
|
|
|
if err := arch.Add(f); err != nil {
|
|
|
|
return fmt.Errorf("could not add %q to archive: %w", f.Source, err)
|
|
|
|
}
|
2022-08-25 01:10:26 -03:00
|
|
|
}
|
|
|
|
|
2022-08-25 02:15:37 -03:00
|
|
|
if err := arch.Close(); err != nil {
|
|
|
|
return fmt.Errorf("could not close archive file: %w", err)
|
|
|
|
}
|
|
|
|
if err := af.Close(); err != nil {
|
|
|
|
return fmt.Errorf("could not close archive file: %w", err)
|
|
|
|
}
|
2022-08-25 01:10:26 -03:00
|
|
|
|
2020-04-12 11:47:46 -03:00
|
|
|
ctx.Artifacts.Add(&artifact.Artifact{
|
|
|
|
Type: artifact.UploadableSourceArchive,
|
|
|
|
Name: filename,
|
|
|
|
Path: path,
|
|
|
|
Extra: map[string]interface{}{
|
2021-10-16 22:46:11 -03:00
|
|
|
artifact.ExtraFormat: ctx.Config.Source.Format,
|
2020-04-12 11:47:46 -03:00
|
|
|
},
|
|
|
|
})
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
|
2020-05-26 00:48:10 -03:00
|
|
|
// Default sets the pipe defaults.
|
2020-04-12 11:47:46 -03:00
|
|
|
func (Pipe) Default(ctx *context.Context) error {
|
2021-04-19 09:31:57 -03:00
|
|
|
archive := &ctx.Config.Source
|
2020-04-12 11:47:46 -03:00
|
|
|
if archive.Format == "" {
|
|
|
|
archive.Format = "tar.gz"
|
|
|
|
}
|
|
|
|
|
|
|
|
if archive.NameTemplate == "" {
|
|
|
|
archive.NameTemplate = "{{ .ProjectName }}-{{ .Version }}"
|
|
|
|
}
|
feat: better archives relative paths (#3656)
with this patch, a config like:
```yaml
archives:
- format: tar.gz
# this name template makes the OS and Arch compatible with the results of uname.
name_template: >-
{{ .ProjectName }}_
{{- title .Os }}_
{{- if eq .Arch "amd64" }}x86_64
{{- else if eq .Arch "386" }}i386
{{- else }}{{ .Arch }}{{ end }}
{{- if .Arm }}v{{ .Arm }}{{ end }}
rlcp: true
files:
- src: "build/**/*"
dst: .
nfpms:
- package_name: foo
contents:
- src: "build/**/*"
dst: usr/share/foo
formats:
- apk
```
will eval this:
<img width="1384" alt="CleanShot 2022-12-21 at 22 21 00@2x"
src="https://user-images.githubusercontent.com/245435/209034244-7c31b5f7-cfcd-4825-bb2f-7dd463c5286a.png">
as much as I would like to make this the default, it would be a breaking
change, so we really can't do it.
If `dst` is empty, it'll have the same behavior as before (no rlcp), and
if `strip_parent` is set, it will also still have the same behavior.
Finally, if the format is binary, `rlcp` is ignored too (as it doesn't
make sense).
So, this only changes if:
- your format is not binary; and
- you have files with `src` and `dst` set
Then, goreleaser will warn you to set `rlcp: true`.
## todo
- [x] docs
- [x] more tests probably
- [x] any ideas for a better name for the new config option?
fixes #3655
Signed-off-by: Carlos A Becker <caarlos0@users.noreply.github.com>
2022-12-27 17:42:55 -03:00
|
|
|
|
|
|
|
if archive.Enabled && !archive.RLCP {
|
|
|
|
deprecate.NoticeCustom(ctx, "source.rlcp", "`{{ .Property }}` will be the default soon, check {{ .URL }} for more info")
|
|
|
|
}
|
2020-04-12 11:47:46 -03:00
|
|
|
return nil
|
|
|
|
}
|