fix(job_attachment)!: Change osType and source_os names #37
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
gahyusuh
force-pushed
the
gahyusuh/rename_os_type
branch
from
aeb1efa
to
7abe659
Compare
gahyusuh
force-pushed
the
gahyusuh/rename_os_type
branch
3 times, most recently
from
03ad36f
to
e2e4fe4
Compare
marofke
reviewed
Sep 25, 2023
| # TODO: remove sourceOs and make sourcePathFormat required | ||
| sourceOs: NotRequired[str] | ||
| """The operating system family (posix/windows) associated with the source path""" | ||
|
|
||
| sourcePathFormat: NotRequired[str] |
There was a problem hiding this comment.
The above todo mentions that this should be made required, is that no longer true? Just want to make sure we didn't miss something
There was a problem hiding this comment.
Thank you for pointing that out. It appears, as you mentioned, this sourcePathFormat is defined as required in the backend service model. I will fix it in the next revision.
BREAKING CHANGES: - Renamed the field `osType` -> `rootPathFormat` - The workarounds that allowed the use of `source_os` in the path mapping rules are removed. Signed-off-by: Gahyun Suh <132245153+gahyusuh@users.noreply.github.com>
gahyusuh
force-pushed
the
gahyusuh/rename_os_type
branch
from
e2e4fe4
to
503484c
Compare
epmog
approved these changes
Sep 25, 2023
marofke
approved these changes
Sep 25, 2023
epmog
approved these changes
Sep 25, 2023
gmchale79
pushed a commit
that referenced
this pull request
Oct 31, 2023
BREAKING CHANGES: - Renamed the field `osType` -> `rootPathFormat` - The workarounds that allowed the use of `source_os` in the path mapping rules are removed. Signed-off-by: Gahyun Suh <132245153+gahyusuh@users.noreply.github.com> Signed-off-by: Graeme McHale <gmchale@amazon.com>
gmchale79
pushed a commit
that referenced
this pull request
Nov 2, 2023
BREAKING CHANGES: - Renamed the field `osType` -> `rootPathFormat` - The workarounds that allowed the use of `source_os` in the path mapping rules are removed. Signed-off-by: Gahyun Suh <132245153+gahyusuh@users.noreply.github.com> Signed-off-by: Graeme McHale <gmchale@amazon.com>
gahyusuh
added a commit
that referenced
this pull request
Nov 6, 2023
BREAKING CHANGES: - Renamed the field `osType` -> `rootPathFormat` - The workarounds that allowed the use of `source_os` in the path mapping rules are removed. Signed-off-by: Gahyun Suh <132245153+gahyusuh@users.noreply.github.com> Signed-off-by: Graeme McHale <gmchale@amazon.com> Signed-off-by: Gahyun Suh <132245153+gahyusuh@users.noreply.github.com>
gmchale79
pushed a commit
that referenced
this pull request
Feb 12, 2024
BREAKING CHANGES: - Renamed the field `osType` -> `rootPathFormat` - The workarounds that allowed the use of `source_os` in the path mapping rules are removed. Signed-off-by: Gahyun Suh <132245153+gahyusuh@users.noreply.github.com> Signed-off-by: Graeme McHale <gmchale@amazon.com>
Closed
gmchale79
pushed a commit
that referenced
this pull request
Mar 11, 2024
BREAKING CHANGES: - Renamed the field `osType` -> `rootPathFormat` - The workarounds that allowed the use of `source_os` in the path mapping rules are removed. Signed-off-by: Gahyun Suh <132245153+gahyusuh@users.noreply.github.com> Signed-off-by: Graeme McHale <gmchale@amazon.com>
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.
What was the problem/requirement? (What/Why)
The field
osType: OperatingSystemFamilyin job/attachments/manifests is currently being used just to determine how to handle the rootPath (i.e., is it 'posix' or 'windows',) in the API, so it follows more closely with the path mapping rules rather than storage profiles. The fieldosTypein job attachment settings should be renamed to something else, to avoid inconsistencies around the usage ofosType,osFamily, and whatever encapsulates 'windows' vs. 'posix' paths.What was the solution? (How)
osType: OperatingSystemFamily->rootPathFormat: PathFormatsource_osin the path mapping rules can now be safely removed."What is the impact of this change?
The field has a better/less-confusing name.
How was this change tested?
hatch run lint && hatch run testWas this change documented?
No.
Is this a breaking change?
Yes!