Skip to content

Commit

Permalink
fix readme
Browse files Browse the repository at this point in the history
  • Loading branch information
dianabarsan committed Sep 18, 2024
1 parent 35b3667 commit 1ef3be8
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions .github/actions/superset-backup/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# superset-backup Shared GitHub action


The `superset-backup` is a parameterised reusable GitHub action that exports all dashboard data from a superset instance and saves it as a zip file in the repository that uses the action.
The `superset-backup` is a parameterised reusable GitHub action that exports dashboard config from a Superset instance and saves it as a zip file in the repository that uses the action.

This action uses the Superset API to authenticate and export dashboard config.
Backups are saved in a `/superset/backups` folder, each backup being a zip file named based on the date and time when the backup was generated. eg. `/superset/backups/20240918082215.zip`.
The format of the export is controlled by superset and no additional transformation is done within this action.
Backups are saved in `/superset/backups` folder, as zip files named based on the date and time when the backups ware generated. eg. `/superset/backups/20240918082215.zip`.
The format of the export is controlled by Superset and no additional transformation is done within this action.

Requires the following variables:
- `gh_token`: GitHub token that has access to push to the main branch of the repository.
Expand All @@ -25,7 +25,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Make backup
uses: 'dianabarsan/superset-backup/.github/actions/superset-backup@main'
uses: 'medic/cht-sync/.github/actions/superset-backup@main'
with:
gh_token: ${{ secrets.GH_TOKEN }}
superset_link: ${{ secrets.SUPERSET_LINK }}
Expand Down

0 comments on commit 1ef3be8

Please sign in to comment.