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

Add a 'summary' field in buildspec #1059

Closed
5 tasks done
shahzebsiddiqui opened this issue May 13, 2022 · 0 comments · Fixed by #1069
Closed
5 tasks done

Add a 'summary' field in buildspec #1059

shahzebsiddiqui opened this issue May 13, 2022 · 0 comments · Fixed by #1069
Assignees

Comments

@shahzebsiddiqui
Copy link
Member

shahzebsiddiqui commented May 13, 2022

The summary field can can be used to describe a test which can be used as extended description. Currently the description field is limited to 80 char defined in https://github.com/buildtesters/buildtest/blob/devel/buildtest/schemas/definitions.schema.json

    "description": {
      "type": "string",
      "description": "The ``description`` field is used to document what the test is doing",
      "maxLength": 80
    },

The idea would be to include similar field without any maxLength. This would be applied to all schemas including script, compiler, and spack.

A typical test could be something like

buildspecs:
  summary_example:
    type: script
    description: Short description limited to 80 characters
    summary: |
      This is a long description of test that 
      can exceed 80 characters and be multiline 
   executor: generic.local.bash
   run: pwd
@dbaaha dbaaha self-assigned this May 23, 2022
@shahzebsiddiqui shahzebsiddiqui assigned Xiangs18 and unassigned dbaaha May 26, 2022
@shahzebsiddiqui shahzebsiddiqui linked a pull request Jun 6, 2022 that will close this issue
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 a pull request may close this issue.

3 participants