Add a module-prefixes field to rename all modules in a pkg #6105
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
cocreature
requested review from
bame-da,
hurryabit and
nemanja-da
as code owners
hurryabit
approved these changes
May 28, 2020
compiler/damlc/daml-opts/daml-opts-types/DA/Daml/Options/Packaging/Metadata.hs
Outdated
Show resolved
Hide resolved
| .. code-block:: yaml | ||
|
|
||
| module-prefixes: | ||
| foo-1.0.0: Foo1 |
There was a problem hiding this comment.
Is it possible to use a prefix with a dot, like Foo.Bar, as well? If not, should we consider making it possible? Either way, let's document what is possible in this regard.
There was a problem hiding this comment.
Yes, we just append it. I’ll document it.
|
|
||
| It is also possible to add a prefix to all modules in a package using | ||
| the ``module-prefixes`` field in your ``daml.yaml``. For the example | ||
| above you can use the following: |
There was a problem hiding this comment.
Should we add some motivation why you would want to do this here? Or shall we add something to the upgrading docs and reference it from here?
There was a problem hiding this comment.
This whole section is about handling module name collisions so the motivation is there but I’ll try to make it a bit clearer.
This PR adds a `module-prefixes` field to `daml.yaml` a a shorthand for specifying a `--package` flag that renames all modules in a package to have the same prefix. The docs are updated to describe how you can use this field and there is a test case that makes sure it works. fixes #4948 changelog_begin - [DAML Compiler] You can now use the new ``module-prefixes`` field in ``daml.yaml`` to add a prefix to all modules from a dependency. This is particularly useful for handling colliding module names during upgrades. See https://docs.daml.com/daml/reference/packages.html#handling-module-name-collisions for more information. changelog_end
…ging/Metadata.hs Co-authored-by: Martin Huschenbett <martin.huschenbett@posteo.me>
changelog_begin changelog_end
cocreature
requested review from
dasormeter,
fabiotudone-da,
garyverhaegen-da,
gerolf-da,
leo-da,
miklos-da,
mziolekda,
rautenrieth-da,
remyhaemmerle-da and
S11001001
as code owners
|
That's really neat. Thanks! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds a
module-prefixesfield todaml.yamla a shorthandfor specifying a
--packageflag that renames all modules in apackage to have the same prefix.
The docs are updated to describe how you can use this field and there
is a test case that makes sure it works.
fixes #4948
changelog_begin
module-prefixesfield indaml.yamlto add a prefix to all modules from a dependency. Thisis particularly useful for handling colliding module names during
upgrades. See
https://docs.daml.com/daml/reference/packages.html#handling-module-name-collisions
for more information.
changelog_end
Pull Request Checklist
CHANGELOG_BEGINandCHANGELOG_ENDtagsNOTE: CI is not automatically run on non-members pull-requests for security
reasons. The reviewer will have to comment with
/AzurePipelines runtotrigger the build.