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.

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

Rename projects to have .project extension #9958

Merged
merged 1 commit into from
May 2, 2024

Conversation

philderbeast
Copy link
Collaborator

@philderbeast philderbeast commented Apr 30, 2024

Fixes #9925, renaming project files to have a .project extension.

Template Β: This PR does not modify cabal behaviour (documentation, tests, refactoring, etc.)

Include the following checklist in your PR:

  • Patches conform to the coding conventions.
  • Is this a PR that fixes CI? If so, it will need to be backported to older cabal release branches (ask maintainers for directions).

.gitlab/ci.sh Show resolved Hide resolved
@TeofilC
Copy link
Collaborator

TeofilC commented Apr 30, 2024

This looks good to me!

A minor point and this is liable to endless bikeshedding so feel free to ignore, but I have a mild preference for release.cabal.project over cabal.release.project. In my mind it's a cabal.project file so that should be the extension. Double barrel extensions like that are relatively common, eg, .tar.gz. And we can avoid accidentally syntax highlighting/ nix filtering some other sort of .project file

@philderbeast
Copy link
Collaborator Author

philderbeast commented Apr 30, 2024

@TeofilC thanks for the good suggestion but for this pull request I don't want depart too much from what we have by scattering the projects. With cabal.*.project they're still adjacent in vscode where I can see hidden files that add to the clutter;

$ tree -a --prune -L 1
.
├── AUTHORS
├── cabal.bootstrap.project
├── cabal.meta.project
├── cabal.project
├── cabal.release.project
├── cabal.validate-libonly.project
├── cabal.validate.project
├── CONTRIBUTING.md
├── .dockerignore
├── fix-whitespace.yaml
├── fourmolu.yaml
├── generics-sop-lens.hs
├── ghc-packages
├── .gitattributes
├── .git-blame-ignore-revs
├── .gitignore
├── .gitlab-ci.yml
├── .hlint.yaml
├── id_rsa_cabal_website.aes256.enc
├── LICENSE
├── .mailmap
├── Makefile
├── README.md
├── .readthedocs.yml
├── release-checklist.md
├── stack.yaml
└── validate.sh

1 directory, 27 files

@philderbeast
Copy link
Collaborator Author

philderbeast commented Apr 30, 2024

A minor point and this is liable to endless bikeshedding so feel free to ignore, but I have a mild preference for release.cabal.project over cabal.release.project. In my mind it's a cabal.project file so that should be the extension.

Unrelated to this pull request but your suggested change @TeofilC prompted me to review the names I used with Updo. There are currently two sets;

  • Canonical Targets: stack.yaml, cabal.project, stack.upgrade.yaml and cabal.upgrade.project.
  • GHC-Prefixed Targets but here it is not just a *.cabal.project but instead ghc-x.y.z.dhall2config.project, ghc-x.y.z.dhall2cabal.project and ghc-x.y.z.dhall2stack.yaml. I'm trying to squeeze a lot of metadata into those filenames.

@philderbeast
Copy link
Collaborator Author

Label merge+no rebase is necessary when the pull request is from an organisation.

- Rename cabal.bootstrap.project
- Rename cabal.meta.project
- Rename cabal.validate-libonly.project
- Rename cabal.validate.project
- Rename cabal.release.project
@mergify mergify bot added the merge delay passed Applied (usually by Mergify) when PR approved and received no updates for 2 days label May 2, 2024
@mergify mergify bot merged commit 26b27be into haskell:master May 2, 2024
49 checks passed
@ulysses4ever
Copy link
Collaborator

CI-related backport

@ulysses4ever
Copy link
Collaborator

@mergify backport 3.12

Copy link
Contributor

mergify bot commented May 21, 2024

backport 3.12

✅ Backports have been created

mergify bot added a commit that referenced this pull request May 23, 2024
* Rename projects to cabal.*.project

- Rename cabal.bootstrap.project
- Rename cabal.meta.project
- Rename cabal.validate-libonly.project
- Rename cabal.validate.project
- Rename cabal.release.project

(cherry picked from commit d8147f6)

# Conflicts:
#	.github/workflows/quick-jobs.yml
#	Makefile
#	cabal.bootstrap.project

* Fix conflict with #9990

---------

Co-authored-by: Phil de Joux <philderbeast@gmail.com>
Co-authored-by: brandon s allbery kf8nh <allbery.b@gmail.com>
Co-authored-by: Artem Pelenitsyn <a.pelenitsyn@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
merge delay passed Applied (usually by Mergify) when PR approved and received no updates for 2 days merge+no rebase
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Switch to using a common .project file extension for projects?
6 participants