Add template-summary and template-description fields to the Template Unit (New) #985
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add two fields for the Template Unit: - template-summary - template-description These fields mimick the summary and description fields of the Job Unit to provide a quick explanation and a longer form one about what a template unit does. Both these fields are translatable, and validation is added for the template-summary field to make sure if a value is provided, it is one line only and is less than 80 characters.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #985 +/- ##
==========================================
+ Coverage 38.81% 38.84% +0.02%
==========================================
Files 333 333
Lines 37029 37046 +17
Branches 6321 6321
==========================================
+ Hits 14374 14391 +17
Misses 22022 22022
Partials 633 633
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
pieqq
changed the title
LiaoU3
pushed a commit
to LiaoU3/checkbox
that referenced
this pull request
Mar 20, 2024
…Unit (New) (canonical#985) * Add template-summary and template-description fields and validators Add two fields for the Template Unit: - template-summary - template-description These fields mimick the summary and description fields of the Job Unit to provide a quick explanation and a longer form one about what a template unit does. Both these fields are translatable, and validation is added for the template-summary field to make sure if a value is provided, it is one line only and is less than 80 characters. * Add unit tests for the new Template Unit fields * Update Template Unit documentation * Add unit tests for the translation methods of the new fields
binli
pushed a commit
to binli/checkbox
that referenced
this pull request
Mar 22, 2024
…Unit (New) (canonical#985) * Add template-summary and template-description fields and validators Add two fields for the Template Unit: - template-summary - template-description These fields mimick the summary and description fields of the Job Unit to provide a quick explanation and a longer form one about what a template unit does. Both these fields are translatable, and validation is added for the template-summary field to make sure if a value is provided, it is one line only and is less than 80 characters. * Add unit tests for the new Template Unit fields * Update Template Unit documentation * Add unit tests for the translation methods of the new fields
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Add two fields to Template Units:
template-summarytemplate-descriptionThese fields mimick the summary and description fields of the Job Unit to provide a quick explanation and a longer form one about what a template unit does.
Both of these fields are translatable, and validation is added for the
template-summaryfield to make sure if a value is provided, it is one line only and less than 80 characters.Resolved issues
https://warthogs.atlassian.net/browse/CHECKBOX-1239
Documentation
Template Unit reference page is updated to mention both fields.
Tests
pytest checkbox-ng/plainbox/impl/unit/test_template.py)template-summaryfield of more than 80 characters, or if the value for this field has more than one line, you will see warnings when running validation for the provider.For instance, if I add the following
template-summaryto an existingxxxtemplate unit in the base provider:and then run
./manage.py validatefor the base provider, I will see three warnings: