search

canonical / checkbox

Checkbox
https://checkbox.readthedocs.io
GNU General Public License v3.0
30 stars 44 forks source link

Add readme file for cases and environ variable for ce-oem-provider (New) #1312

Open stanley31huang opened 1 week ago

stanley31huang commented 1 week ago

Description

Add readme file for cases and environ variable for ce-oem-provider

We would like to have a document to describe which environ variable has been defined in the checkbox-ce-oem provider

Resolved issues

N/A

Documentation

N/A

Tests

N/A

stanley31huang commented 4 days ago

@pieqq Thanks for the suggestion, I have updated the PR and please see my inline comments

This must have required a lot of work, unless you had some kind of script to generate the content!

A few comments:

  • In the "Affected Test Cases" sections, I would point directly to the job in the pxu file. You can use relative links, and GitHub will understand them. Doing this will avoid a lot of duplicated data (environ, summary, description, command) that will probably go out of date quickly

The reason we generate this kind of markdown files is to have a better view to know how to configure the environ variable. As you may know that not all of jobs has clear description to describe how to configure it, so we may need to look into the command section.

So the idea is to shows some key information in the markdown file and also have a hyperlink to the source file.

  • How do you plan on maintaining this? Are other contributors to ce-oem-provider aware they have to update the associated md files if they introduce a new environment key? Maybe you can add this to the README file.

I have uploaded the scripts which use to generate the Markdown file and added a section to describe how to update them. we had a discussion in QA team about how to maintain those markdown file, the idea is add an step in the github workflow to update those markdown file regularly.