feat: better archives relative paths

[caarlos0]

with this patch, a config like:

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:

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

• docs
• more tests probably
• any ideas for a better name for the new config option?

fixes #3655

[caarlos0]

One idea:

• make it warns that relative: true will be default soon (maybe specify a version, e.g. v1.21.0)
• wait 6mo (or until the specified version)
• make it the default
• deprecation warning for 6 months so people can remove the option from their configs
• remove it completely

would take 1 year to phase it all, but IMHO is the safest way to do so, if we decide to go that way.

Thoughts?

[codecov]

Codecov Report

Merging #3656 (51192d2) into main (46fdb55) will increase coverage by 0.00%.
The diff coverage is 87.03%.

❗ Current head 51192d2 differs from pull request most recent head 0bb05f4. Consider uploading reports for the commit 0bb05f4 to get more accurate results

@@           Coverage Diff           @@
##             main    #3656   +/-   ##
=======================================
  Coverage   83.59%   83.59%           
=======================================
  Files         118      118           
  Lines        9875     9919   +44     
=======================================
+ Hits         8255     8292   +37     
- Misses       1306     1311    +5     
- Partials      314      316    +2     

Impacted Files	Coverage Δ
pkg/config/config.go	95.21% <ø> (ø)
internal/archivefiles/archivefiles.go	92.55% <83.33%> (-7.45%)	⬇️
internal/pipe/archive/archive.go	92.88% <100.00%> (+0.09%)	⬆️
internal/pipe/sourcearchive/source.go	80.76% <100.00%> (+1.89%)	⬆️
internal/artifact/artifact.go	85.37% <0.00%> (-0.05%)	⬇️

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

[ioga]

One idea:

* make it warns that `relative: true` will be default soon (maybe specify a version, e.g. v1.21.0)

* wait 6mo (or until the specified version)

* make it the default

* deprecation warning for 6 months so people can remove the option from their configs

* remove it completely

would take 1 year to phase it all, but IMHO is the safest way to do so, if we decide to go that way.

Thoughts?

since relative: true will be a new default global behavior, I'd suggest making it an option on archives (or at the top level), instead of having it to be an option on each entry under archives -> files, because you probably don't want to let people mix old and new behavior in their configurations, as it'll make the migration harder.

[caarlos0]

yes, that makes sense @ioga.

Will do it! Thank you!

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Updated
goreleaser	🔄 Building (Inspect)		Dec 27, 2022 at 8:31PM (UTC)

[caarlos0]

fwiw, renamed to rlcp (relative longest common path) so its less confusing, and purposefully require a little bit of reading.