paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 45 Packages Projects Releases Wiki Activity

Feedback changes and changeset

Browse Source 
Signed-off-by: Andre Wanlin <awanlin@rapidrtc.com>
This commit is contained in:
Andre Wanlin
2021-12-30 14:08:53 -06:00
parent 099e540595
commit e188b37024
2 changed files with 10 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.changeset/two-rice-pull.md
+9
View File
@@ -0,0 +1,9 @@
---
'@backstage/backend-tasks': patch
---
Updated README to clarify the following:
- Dashes cannot be used in the `id`, changed to an underscore in the example
- The `timeout` is required, this was also added to the example
- Added a note about tasks not running as expected for local development using persistent database
packages/backend-tasks/README.md
+1 -1
View File
@@ -32,7 +32,7 @@ await scheduler.scheduleTask({
## Local Development
When working with backend-tasks you may run into your task not running as expected if you are using a persistent database. A table called "backstage_backend_tasks\_\_tasks" in the applicable plugin's database will contain a record with the next run date and time. You can delete this record to get things back to what you expect
When working with the `@backstage/backend-tasks` library you may run into your task not running immediately at startup as expected if you are using a persistent database. This is by design - the library respects the previous state and does not run the task sooner than the specified frequency. If you want to get around this, there is a table called `backstage_backend_tasks__tasks` in the applicable plugin's database which will contain a record with the next run date and time. You can delete this record to get things back to what you expect.
## Documentation