Skip to content

Release process/testing/versions and README/tooling files #124

@gitwjr

Description

@gitwjr

@louaybassbouss
On the DPCTF 2025/02/18 call we discussed the issues with releases and Deploy README/tooling files. Louay and @gitwjr were asked to propose solutions. These are my suggestions for the release/testing/versions issues and some additional suggestions. This is a strawman and may need to be broken into separate issues. Please comment.

Process

  1. Any changes to any part of the “latest” Master should be fully tested with the actual versions that will remain in the Master prior to updating the Master.
  2. That testing should use a platform loaded with the same versions of Ubuntu (or Windows/WSL), etc. as was used to test the existing Master. When first discussing the Release Process, we discussed maintaining a “Golden” platform.
  3. Is it possible to have a branch that is used to assemble the release versions of TR, OF, Tests, Content used to test what is to be released in one place so it can be tested exactly as it will be in the Master? After it passes, then release (make public?) that exact file to Master as a unit.

README

  1. Identify in the README "Host Machine Requirements” the versions of code that are confirmed compatible with the Test Suite or that were used in testing prior to release? e.g. Ubuntu, Python, Docker, openssl, Windows and WSL.
  2. Is it possible to list additional versions known to be compatible? E.g. Ubuntu xx.xx through yy.yy; Docker m.m through n.n
  3. When doing a (complete?) rebuild, is it a good practice to remove the related containers and images prior to the rebuild? The problem, I found, is when there is a new release it’s not clear what has changed: Tests, content, code/DOF and which images/containers are affected.

Other:

  1. Need to update the Wave Landing page. When you go to the current page https://www.cta.tech/Resources/Standards/WAVE-Project/WAVE-Streaming-Media-Test-Suite-Devices and click on “Test Suite Releases and README “Latest” it goes to DPCTF Deploy v2.0.1 (Sep 18, 2024) and from there points to the ReadMe.md Deploy v2.0.1 which is not the latest. E.g. no Installation instructions for WSL.
  2. Are there any other pages/links that need to be updated when a new Master is released?

“Like to” changes
Can we eliminate Warnings in docker Logs when a test is run. When troubleshooting I didn’t know if these warnings were related to the failure of the test to run. I got 3 warnings:
From the logs
3 warnings found (use --debug to expand):

  • LegacyKeyValueFormat: "ENV key=value" should be used instead of legacy "ENV key value" format (line 10)
  • LegacyKeyValueFormat: "ENV key=value" should be used instead of legacy "ENV key value" format (line 62)
  • JSONArgsRecommended: JSON arguments recommended for CMD to prevent unintended behavior related to OS signals (line 64)
    NOTE: It appears that this last one recommends using JSON syntax instead of a shell command string.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions