Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Neutral field (like extra-files or extra-sdist-files) to add files to sdist #8817

Closed
andreasabel opened this issue Feb 27, 2023 · 1 comment · Fixed by #10107
Closed

Neutral field (like extra-files or extra-sdist-files) to add files to sdist #8817

andreasabel opened this issue Feb 27, 2023 · 1 comment · Fixed by #10107
Labels
Cabal: file format re: extra-doc-files re: extra-source-files

Comments

@andreasabel
Copy link
Member

andreasabel commented Feb 27, 2023 •
edited
Loading

We currently have 3 ways to put extra files into the sdist tarball, but all of these have special semantics:

  1. data-files: files used by the package at runtime
  2. extra-source-files: files that may be used during cabal build (and thus changes might trigger a rebuild)
  3. extra-doc-files: copied by cabal haddock into the documentation folder

Often one of the latter is abused to add files that have no semantics for cabal, like stack*.yaml files to build with stack, or files like READMEs or CHANGELOGs that maybe be regarded by Hackage, but are misplaced in any of the 3 classes.

Suggestion: add a fourth, neutral field for adding files without semantics, e.g.

extra-sdist-files:
  README.md
  CHANGELOG.md
  stack-9.4.4.yaml
  stack-9.2.6.yaml
  ...

Or, make a structured extra-files entry:

extra-files:
  source:
    config.mk  --whatever, I never use this
    ...
  doc:
    ... -- lacking imagination here as well
  other:
    CHANGELOG.md
    README.md
    stack-9.4.4.yaml
    ...

Lifted from:
@dio4ev
Copy link

dio4ev commented Feb 27, 2024

I support this idea and would be in need of such a field.

tbidne added a commit to tbidne/cabal that referenced this issue Jun 12, 2024
@tbidne
New extra-files for adding neutral fields to sdist
f322049 
The new extra-files field provides a way to specify extra files that
should be included in sdist, without adding any other semantics
(cf. extra-source-files are tracked by 'cabal build').

Resolves haskell#8817.
tbidne added a commit to tbidne/cabal that referenced this issue Jun 12, 2024
@tbidne
New extra-files for adding neutral fields to sdist
fa54f3e 
The new extra-files field provides a way to specify extra files that
should be included in sdist, without adding any other semantics
(cf. extra-source-files are tracked by 'cabal build').

Resolves haskell#8817.
tbidne added a commit to tbidne/cabal that referenced this issue Jun 12, 2024
@tbidne
New extra-files field for neutral sdist files
d1d3665 
The new extra-files field provides a way to specify extra files that
should be included in sdist, without adding any other semantics
(cf. extra-source-files are tracked by 'cabal build').

Resolves haskell#8817.
@tbidne tbidne mentioned this issue Jun 12, 2024
Merged
5 tasks
tbidne added a commit to tbidne/cabal that referenced this issue Jun 12, 2024
@tbidne
New extra-files field for neutral sdist files
f649fcd 
The new `extra-files` field provides a way to specify extra files that
should be included in sdist, without adding any other semantics
(cf. `extra-source-files` are tracked by `cabal build`).

Resolves haskell#8817.
tbidne added a commit to tbidne/cabal that referenced this issue Jun 13, 2024
@tbidne
New extra-files field for neutral sdist files
5eb6de8 
The new `extra-files` field provides a way to specify extra files that
should be included in sdist, without adding any other semantics
(cf. `extra-source-files` are tracked by `cabal build`).

Resolves haskell#8817.
tbidne added a commit to tbidne/cabal that referenced this issue Jun 13, 2024
@tbidne
New extra-files field for neutral sdist files
16374fe 
The new `extra-files` field provides a way to specify extra files that
should be included in sdist, without adding any other semantics
(cf. `extra-source-files` are tracked by `cabal build`).

Resolves haskell#8817.
tbidne added a commit to tbidne/cabal that referenced this issue Jul 3, 2024
@tbidne
New extra-files field for neutral sdist files
e419000 
The new `extra-files` field provides a way to specify extra files that
should be included in sdist, without adding any other semantics
(cf. `extra-source-files` are tracked by `cabal build`).

Resolves haskell#8817.
tbidne added a commit to tbidne/cabal that referenced this issue Jul 3, 2024
@tbidne
New extra-files field for neutral sdist files
462cd0d 
The new `extra-files` field provides a way to specify extra files that
should be included in sdist, without adding any other semantics
(cf. `extra-source-files` are tracked by `cabal build`).

Resolves haskell#8817.
tbidne added a commit to tbidne/cabal that referenced this issue Jul 3, 2024
@tbidne
New extra-files field for neutral sdist files
9318243 
The new `extra-files` field provides a way to specify extra files that
should be included in sdist, without adding any other semantics
(cf. `extra-source-files` are tracked by `cabal build`).

Resolves haskell#8817.
tbidne added a commit to tbidne/cabal that referenced this issue Jul 4, 2024
@tbidne
New extra-files field for neutral sdist files
b88f0c9 
The new `extra-files` field provides a way to specify extra files that
should be included in sdist, without adding any other semantics
(cf. `extra-source-files` are tracked by `cabal build`).

Resolves haskell#8817.
tbidne added a commit to tbidne/cabal that referenced this issue Jul 5, 2024
@tbidne
New extra-files field for neutral sdist files
29fa503 
The new `extra-files` field provides a way to specify extra files that
should be included in sdist, without adding any other semantics
(cf. `extra-source-files` are tracked by `cabal build`).

Resolves haskell#8817.
tbidne added a commit to tbidne/cabal that referenced this issue Jul 5, 2024
@tbidne
New extra-files field for neutral sdist files
cd6d11b 
The new `extra-files` field provides a way to specify extra files that
should be included in sdist, without adding any other semantics
(cf. `extra-source-files` are tracked by `cabal build`).

Resolves haskell#8817.
tbidne added a commit to tbidne/cabal that referenced this issue Jul 7, 2024
@tbidne
New extra-files field for neutral sdist files
0f5d7f6 
The new `extra-files` field provides a way to specify extra files that
should be included in sdist, without adding any other semantics
(cf. `extra-source-files` are tracked by `cabal build`).

Resolves haskell#8817.
tbidne added a commit to tbidne/cabal that referenced this issue Jul 8, 2024
@tbidne
New extra-files field for neutral sdist files
7d95210 
The new `extra-files` field provides a way to specify extra files that
should be included in sdist, without adding any other semantics
(cf. `extra-source-files` are tracked by `cabal build`).

Resolves haskell#8817.
tbidne added a commit to tbidne/cabal that referenced this issue Jul 8, 2024
@tbidne
New extra-files field for neutral sdist files
7fd3722 
The new `extra-files` field provides a way to specify extra files that
should be included in sdist, without adding any other semantics
(cf. `extra-source-files` are tracked by `cabal build`).

Resolves haskell#8817.
tbidne added a commit to tbidne/cabal that referenced this issue Jul 8, 2024
@tbidne
New extra-files field for neutral sdist files
ad854a2 
The new `extra-files` field provides a way to specify extra files that
should be included in sdist, without adding any other semantics
(cf. `extra-source-files` are tracked by `cabal build`).

Resolves haskell#8817.
tbidne added a commit to tbidne/cabal that referenced this issue Jul 8, 2024
@tbidne
New extra-files field for neutral sdist files
b18dbcb 
The new `extra-files` field provides a way to specify extra files that
should be included in sdist, without adding any other semantics
(cf. `extra-source-files` are tracked by `cabal build`).

Resolves haskell#8817.
tbidne added a commit to tbidne/cabal that referenced this issue Jul 8, 2024
@tbidne
New extra-files field for neutral sdist files
818e16c 
The new `extra-files` field provides a way to specify extra files that
should be included in sdist, without adding any other semantics
(cf. `extra-source-files` are tracked by `cabal build`).

Resolves haskell#8817.
tbidne added a commit to tbidne/cabal that referenced this issue Jul 18, 2024
@tbidne
New extra-files field for neutral sdist files
83973fc 
The new `extra-files` field provides a way to specify extra files that
should be included in sdist, without adding any other semantics
(cf. `extra-source-files` are tracked by `cabal build`).

Resolves haskell#8817.
tbidne added a commit to tbidne/cabal that referenced this issue Jul 22, 2024
@tbidne
New extra-files field for neutral sdist files
06bdd32 
The new `extra-files` field provides a way to specify extra files that
should be included in sdist, without adding any other semantics
(cf. `extra-source-files` are tracked by `cabal build`).

Resolves haskell#8817.
ulysses4ever pushed a commit to tbidne/cabal that referenced this issue Jul 30, 2024
@tbidne @ulysses4ever
New extra-files field for neutral sdist files
b791290 
The new `extra-files` field provides a way to specify extra files that
should be included in sdist, without adding any other semantics
(cf. `extra-source-files` are tracked by `cabal build`).

Resolves haskell#8817.
tbidne added a commit to tbidne/cabal that referenced this issue Jul 31, 2024
@tbidne
New extra-files field for neutral sdist files
7444ed5 
The new `extra-files` field provides a way to specify extra files that
should be included in sdist, without adding any other semantics
(cf. `extra-source-files` are tracked by `cabal build`).

Resolves haskell#8817.
tbidne added a commit to tbidne/cabal that referenced this issue Jul 31, 2024
@tbidne
New extra-files field for neutral sdist files
4c90694 
The new `extra-files` field provides a way to specify extra files that
should be included in sdist, without adding any other semantics
(cf. `extra-source-files` are tracked by `cabal build`).

Resolves haskell#8817.
@mergify mergify bot closed this as completed in #10107 Aug 2, 2024
@mergify mergify bot closed this as completed in 8d06c30 Aug 2, 2024
mpickering pushed a commit to mpickering/cabal that referenced this issue Aug 12, 2024
@tbidne @mpickering
New extra-files field for neutral sdist files
d7e70bd 
The new `extra-files` field provides a way to specify extra files that
should be included in sdist, without adding any other semantics
(cf. `extra-source-files` are tracked by `cabal build`).

Resolves haskell#8817.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Cabal: file format re: extra-doc-files re: extra-source-files
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

New extra-files field for neutral sdist files tbidne/cabal
2 participants
@andreasabel @dio4ev