mirror of
https://github.com/fhswf/aki_prj23_transparenzregister.git
synced 2025-04-20 21:42:53 +02:00
Readme text on how to enable dependabot & actions (#519)
Added texts and images that show how dependabot and actions should be updated. --------- Co-authored-by: Tristan Nolde <tristan.nolde@yahoo.de>
This commit is contained in:
parent
4d10f8a076
commit
04bcc3c458
BIN
Actions-annotatet.PNG
Normal file
BIN
Actions-annotatet.PNG
Normal file
Binary file not shown.
After Width: | Height: | Size: 64 KiB |
BIN
Dependabot-annotatet.PNG
Normal file
BIN
Dependabot-annotatet.PNG
Normal file
Binary file not shown.
After Width: | Height: | Size: 91 KiB |
18
README.md
18
README.md
@ -16,7 +16,7 @@ The project has currently the following entrypoint available:
|
|||||||
- **find-missing-companies** > Retrieves meta information of companies referenced by others but not yet part of the dataset.
|
- **find-missing-companies** > Retrieves meta information of companies referenced by others but not yet part of the dataset.
|
||||||
- **ingest** > Scheduled data ingestion of news articles as well as missing companies and financial data.
|
- **ingest** > Scheduled data ingestion of news articles as well as missing companies and financial data.
|
||||||
|
|
||||||
All entrypoints support the `-h` argument and show a short help.
|
All entrypoints support the `-h` argument that shows a short help text.
|
||||||
|
|
||||||
## Applikation startup
|
## Applikation startup
|
||||||
|
|
||||||
@ -126,3 +126,19 @@ To use the `*.json` use the path to it as an argument when using an entrypoint (
|
|||||||
We support both sqlite and postgres because a local db is filled in about 10% of the time the remote db needs to be completed.
|
We support both sqlite and postgres because a local db is filled in about 10% of the time the remote db needs to be completed.
|
||||||
Even tough we use the `sqlite` for testing the connection can't manage multithreading or multiprocessing.
|
Even tough we use the `sqlite` for testing the connection can't manage multithreading or multiprocessing.
|
||||||
This clashes with the webserver. For production mode use the `postgres`-db.
|
This clashes with the webserver. For production mode use the `postgres`-db.
|
||||||
|
|
||||||
|
## Re-Enable Actions & Dependabot
|
||||||
|
|
||||||
|
After the project is over all computation using parts should be turned off.
|
||||||
|
|
||||||
|
To enable all the features please enable the GitHub Actions first.
|
||||||
|
The following image shows where the buttons to enable the actions can be found.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
Additionally, it is recommended to enable Dependabot.
|
||||||
|
Please note that patches are currently only demanded for critical security fixes.
|
||||||
|
Use `poetry update` prior to restarting the project to update all the python dependencies.
|
||||||
|
Note that both security updates and alerts should be enabled.
|
||||||
|
|
||||||
|

|
||||||
|
BIN
documentations/Actions-annotatet.PNG
Normal file
BIN
documentations/Actions-annotatet.PNG
Normal file
Binary file not shown.
After Width: | Height: | Size: 64 KiB |
BIN
documentations/Dependabot-annotatet.PNG
Normal file
BIN
documentations/Dependabot-annotatet.PNG
Normal file
Binary file not shown.
After Width: | Height: | Size: 91 KiB |
Loading…
x
Reference in New Issue
Block a user