Kaynağa Gözat

Changelog & documentation for #5479

jeremystretch 3 yıl önce
ebeveyn
işleme
1d8b8aad3b

+ 3 - 1
docs/customization/custom-scripts.md

@@ -91,7 +91,9 @@ commit_default = False
 
 ### `job_timeout`
 
-Set the allowed runtime of a script. If not set the `RQ_DEFAULT_TIMEOUT` will be used.
+Set the maximum allowed runtime for the script. If not set, `RQ_DEFAULT_TIMEOUT` will be used.
+
+!!! info "This feature was introduced in v3.2.1"
 
 ## Accessing Request Data
 

+ 14 - 0
docs/customization/reports.md

@@ -85,6 +85,20 @@ As you can see, reports are completely customizable. Validation logic can be as
 !!! warning
     Reports should never alter data: If you find yourself using the `create()`, `save()`, `update()`, or `delete()` methods on objects within reports, stop and re-evaluate what you're trying to accomplish. Note that there are no safeguards against the accidental alteration or destruction of data.
 
+## Report Attributes
+
+### `description`
+
+A human-friendly description of what your report does.
+
+### `job_timeout`
+
+Set the maximum allowed runtime for the report. If not set, `RQ_DEFAULT_TIMEOUT` will be used.
+
+!!! info "This feature was introduced in v3.2.1"
+
+## Logging
+
 The following methods are available to log results within a report:
 
 * log(message)

+ 1 - 0
docs/release-notes/version-3.2.md

@@ -4,6 +4,7 @@
 
 ### Enhancements
 
+* [#5479](https://github.com/netbox-community/netbox/issues/5479) - Allow custom job timeouts for scripts & reports
 * [#8973](https://github.com/netbox-community/netbox/issues/8973) - Display VLAN group count under site view
 
 ### Bug Fixes