Skip to content

fix!: updates to path mapping - #5

Merged
mwiebe merged 1 commit into
mainlinefrom
ddneilson/update_path_mapping
Sep 14, 2023
Merged

fix!: updates to path mapping#5
mwiebe merged 1 commit into
mainlinefrom
ddneilson/update_path_mapping

Conversation

@ddneilson

Copy link
Copy Markdown
Contributor

What was the problem/requirement? (What/Why)

Two changes related to updates in the spec:

  1. The field name source_os in a path mapping rule's definition was determined to be somewhat ambiguous in its meaning. So, it is being changed to source_path_format.
  2. We passed path mapping rules in an environment variable before the introduction of the Session.PathMappingRulesFile value. With the creation of that value for format strings, we deprecated the PATH_MAPPING_RULES environment variable. It is time to delete it.

What was the solution? (How)

Apply the changes as described.

What is the impact of this change?

Compatibility with the spec that we are releasing.

How was this change tested?

This code is heavily unit/integration tested. Tests were updated and are passing.

Was this change documented?

Yes, in the specification documentation.

Is this a breaking change?

Yes.


By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

@ddneilson
ddneilson requested a review from a team as a code owner September 9, 2023 21:24
@ddneilson
ddneilson force-pushed the ddneilson/update_path_mapping branch from 97d06c9 to 3856d4c Compare September 13, 2023 16:45
Two changes related to updates in the spec:
1. The field name `source_os` in a path mapping rule's definition was determined
   to be somewhat ambiguous in its meaning. So, it is being changed to
   `source_path_format`.
2. We passed path mapping rules in an environment variable before the
   introduction of the Session.PathMappingRulesFile value. With the
   creation of that value for format strings, we deprecated the
   PATH_MAPPING_RULES environment variable. It is time to delete it.

**BREAKING CHANGE**
1. The format of the path mapping rules JSON is changed such that the
   'source_os' key is now called 'source_path_format'
2. The PATH_MAPPING_RULES environment variable is no longer injected in
   to a running Session's environment.

Signed-off-by: Daniel Neilson <53624638+ddneilson@users.noreply.github.com>
@ddneilson
ddneilson force-pushed the ddneilson/update_path_mapping branch from 3856d4c to 61777a1 Compare September 14, 2023 18:17
@mwiebe
mwiebe merged commit 2321af9 into mainline Sep 14, 2023
@mwiebe
mwiebe deleted the ddneilson/update_path_mapping branch September 14, 2023 18:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants