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

Adding os.build_id resource attribute and discussion why os.sdk.version isn't required #293

Merged

Conversation

surbhiia
Copy link
Contributor

@surbhiia surbhiia commented Aug 31, 2023

Note: I've preserved the conversation as it went and not editing my this comment. But the only change done in this PR was adding os.build_id resource attribute. And we discussed in detail why os.sdk.version is not required to be in os.yaml

##Changes
Following changes have been done in os.yaml and os.md

  • Added os.build attribute
  • Added os.sdk_version attribute

Rationale behind the proposal:

os.build
Currently, os.version is available to add the complete version number along with build numbers. As the syntax of build numbers is different across different platforms it becomes difficult to parse the os.version attribute to extract the build number. Also for platforms like android where there can be multiple different manufacturers, build numbers can be defined differently. Google has also changed it's syntax for android build numbers from what it was earlier.

In last two week's client sig meetings where there was representation from the following platforms - Browser, iOS and Android, it was brought up, discussed and consensus was reached on the requirement of a separate attribute os.build to capture the build number.

Right now, iOS and Android are getting by this concern by adding build numbers to the os.description field:
IOS example: “iOS Version 16.4 (Build 20E247)”
Android example:
Screenshot 2023-08-29 at 1 11 15 PM

os.sdk_version
Additionally, there is no attribute to identify the SDK version (set of development tools & APIs used for development). It's not always 1 to 1 with the version number and is required to troubleshoot issues. Example - As seen here in android version number 12 can be associated with both API level 31 & 32.

Other things on the PR:

  • I do not think I need to change schema-next.yaml for this change as it only allows attribute_rename under resource. Please correct me if I'm wrong.

Merge requirement checklist

Sorry, something went wrong.

surbhiia and others added 3 commits August 30, 2023 14:21

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
…butes
@surbhiia surbhiia requested review from a team August 31, 2023 00:25
@surbhiia surbhiia marked this pull request as draft August 31, 2023 00:26
@surbhiia surbhiia marked this pull request as ready for review August 31, 2023 01:37
docs/resource/os.md Outdated Show resolved Hide resolved
docs/resource/os.md Outdated Show resolved Hide resolved
surbhiia and others added 4 commits August 31, 2023 11:06

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
…butes
Copy link
Member

@joaopgrassi joaopgrassi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please, adapt the PR title to reflect the fact only os.build is being added.

CHANGELOG.md Outdated Show resolved Hide resolved
docs/resource/os.md Outdated Show resolved Hide resolved
model/resource/os.yaml Outdated Show resolved Hide resolved
@surbhiia surbhiia changed the title Adding os.build and os.sdk_version resource attributes Adding os.build resource attribute and discussion why os.sdk_version isn't required Sep 15, 2023
@surbhiia
Copy link
Contributor Author

Please, adapt the PR title to reflect the fact only os.build is being added.

I thought of it but wanted to keep it so others can benefit from the discussion. I updated it to reflect what exactly it covers.

@surbhiia surbhiia changed the title Adding os.build resource attribute and discussion why os.sdk_version isn't required Adding os.build resource attribute and discussion why os.sdk.version isn't required Sep 15, 2023
surbhiia and others added 2 commits September 15, 2023 08:57

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
Co-authored-by: Joao Grassi <joao@joaograssi.com>

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
Co-authored-by: Christian Neumüller <christian+github@neumueller.me>
@surbhiia surbhiia changed the title Adding os.build resource attribute and discussion why os.sdk.version isn't required Adding os.build_id resource attribute and discussion why os.sdk.version isn't required Sep 15, 2023

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
@surbhiia
Copy link
Contributor Author

@jsuereth This is my first PR in this repo and I'm not sure if I'm missing any last steps here. Is there anything I need to do next to get this pull request merged? I did resolve conflicts in changelog.md previously but I guess that'll keep happening everyday until this PR is merged. I'm not sure if I should do that everyday?

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
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.

None yet

9 participants