search

bgamari / dhall-gitlab-ci

A Dhall encoding of the GitLab CI configuration schema
BSD 3-Clause "New" or "Revised" License
46 stars 19 forks source link

Restructure to more closely follow conventions from Prelude #2

Closed mx00s closed 4 years ago

mx00s commented 4 years ago

The top-level package.dhall file gives users a single entrypoint to access expressions in this repo.

There were some name and structuring changes which affect the exposed top-level expressions. For example, all the functions in ./rendering were moved to toJSON.dhall files in the appropriate ./GitLab/<type>/ directories. More concretely, ./rendering/Top.dhall became (./package.dhall).Top.toJSON.

This resolves #1.

bgamari commented 4 years ago

One question I have is whether the files which aren't suffixed with .dhall are truly necessary. My understanding is that they were introduced into the Prelude strictly as a backwards compatibility measure. I'd prefer to eliminate this source of noise if it isn't actually best-practice.

mx00s commented 4 years ago

No, they're not necessary. That's a good point that it was done that way for backwards compatibility; I hadn't considered that. dhall-kubernetes consistently uses the .dhall extension.

I will remove the unnecessary files.

mx00s commented 4 years ago

The latest commit removes those unnecessary files.