haskell / haskell/cabal

sdist should follow symlinks

Open
#3,963 11 comments 0 reactions 0 assignees View on GitHub
cabal-install: cmd/sdist meta: easy type: enhancement
Dominant language
Haskell
Stars
1.7k
Forks
750
Avg merge
4d 3h
Merged PRs (30d)
28

Description

**Summary:** instead of going with the originally proposed design we decided that `cabal sdist` should be changed to follow symlinks. Symlinks are not portable anyway, so the generated tarballs shouldn't include them. Original ticket description below.

---

For multi-package projects it would be nice if one could include e.g. common READMEs or CONTRIBUTING files in each package.

Currently, when I try this with `stack sdist` using `Cabal-1.24.0.0`, I get the following message:

```
'extra-src-files: ../README.md' is a relative path outside of the source tree. This will not work when generating a tarball with 'sdist'.
```

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.