Skip to content

Redundant test build version indicators #842

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

Closed
per1234 opened this issue Feb 17, 2022 · 2 comments
Closed

Redundant test build version indicators #842

per1234 opened this issue Feb 17, 2022 · 2 comments
Assignees
Labels
conclusion: resolved Issue was resolved topic: infrastructure Related to project infrastructure type: imperfection Perceived defect in any part of project

Comments

@per1234
Copy link
Contributor

per1234 commented Feb 17, 2022

Describe the bug

Test builds are generated for every PR creation and push as well as pushes to the main branch. These make it easy for anyone to contribute to the project through beta testing.

It is important that the specific test build in use be easily identifiable. The Git commit hash is used for this purpose. For example, the version assigned to this commit: 9ecff86 is 2.0.0-rc3-snapshot-9ecff86

🐛 The version indicator is now added twice to the test build versions. For example, the the version assigned to this commit: 9b1f15d is 2.0.0-rc4-snapshot.9b1f15d-snapshot-9b1f15d

To Reproduce

  1. Open the list of push or pull_request event-triggered runs of the Arduino IDE workflow:
    https://github.com/arduino/arduino-ide/actions/workflows/build.yml?query=event%3Apull_request+event%3Apush+is%3Asuccess
  2. Click on any recent item in the list of runs.
    For example: https://github.com/arduino/arduino-ide/actions/runs/1858133816
  3. Under the "Artifacts" section of the page, click on the download link of the artifact for your operating system.
  4. Wait for the download to finish.
  5. Extract or install the downloaded file.
    🐛 The extracted folder contains redundant version indicators (e.g., arduino-ide_2.0.0-rc4-snapshot.9b1f15d-snapshot-9b1f15d_Windows_64bit)
  6. Start the Arduino IDE test build.
    🐛 The window title contains redundant version indicators (e.g., "sketch_feb17a | Arduino IDE 2.0.0-rc4-snapshot.9b1f15d-snapshot-9b1f15d")
  7. Select Help > About Arduino IDE from the Arduino IDE menus.
  8. Click the Copy button.
  9. Paste the contents of the clipboard into any text editor.
    🐛 The pasted text contains redundant version indicators.
    For example:
    Version: 2.0.0-rc4-snapshot.9b1f15d-snapshot-9b1f15d
    Date: 2022-02-17T10:40:50.003Z
    CLI Version: 0.21.0 [10107d24]
    
    Copyright © 2022 Arduino SA
    

Expected behavior

The tester builds don't have redundant version indicators (e.g., 2.0.0-rc4-snapshot.9b1f15d).

Desktop

  • OS: Windows 10, Ubuntu 20.04
  • Version: 2.0.0-rc4-snapshot.9b1f15d-snapshot-9b1f15d
    Date: 2022-02-17T10:40:50.003Z
    CLI Version: 0.21.0 [10107d24]

Additional context

The change was introduced at f660058

There was a previous change from the snapshot.<hash> (e.g., 2.0.0-rc3-snapshot.69ac1f4) to snapshot-<hash> format (e.g., 2.0.0-rc3-snapshot-112153f), which was introduced in 112153f


The additional characters use up some of the precious allowance of path length doled out by Microsoft for the beta testers on Windows.


Seeing this identifier in the filename redundantly, but with two different formats (note the . in one and - in the other) makes me nervous that it is an indication of something fragile.

@per1234 per1234 added topic: infrastructure Related to project infrastructure type: imperfection Perceived defect in any part of project labels Feb 17, 2022
@AlbyIanna
Copy link
Contributor

Looks like we messed up when merging code into the branch (most probably my fault 😮‍💨 )
f660058#diff-3e05d14f91a7dddba50598a767e65b6278c000064034da31da684affbaf1d471R81-R95

@per1234 thank you so much for reporting this! Fixing it right away!

@AlbyIanna AlbyIanna assigned AlbyIanna and unassigned silvanocerza Feb 17, 2022
@per1234
Copy link
Contributor Author

per1234 commented Mar 7, 2022

Fixed by #846
Thanks Alberto!

@per1234 per1234 closed this as completed Mar 7, 2022
@per1234 per1234 added the conclusion: resolved Issue was resolved label Mar 7, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
conclusion: resolved Issue was resolved topic: infrastructure Related to project infrastructure type: imperfection Perceived defect in any part of project
Projects
None yet
Development

No branches or pull requests

3 participants