rclement / datasette-dashboards

Datasette plugin providing data dashboards from metadata
https://datasette-dashboards-demo.vercel.app
Apache License 2.0
137 stars 7 forks source link

README screenshot is out-of-date #87

Closed rclement closed 1 year ago

rclement commented 1 year ago

The features are implemented in this plugin and incorporated into the demo deployment, the more the README screenshot is out-of-date!

In order to automate the process of keeping the screenshot up-to-date, one solution would be to use shot-scraper:

As this tool is using a browser automation, we might be able to point it to the demo dashboard and wait for a certain amount of time (or condition) to take the shot, so that all JS code has been executed and rendered.

rclement commented 1 year ago

The shot-scraper route works great but the demo dashboard is not deterministic because of the word cloud chart!

Also, two triggering options:

To use the GITHUB_TOKEN, the better way is to define the permissions setting in workflow

rclement commented 1 year ago

The main branch is protected and commiting from GHA results in the following error:

remote: error: GH006: Protected branch update failed for refs/heads/master.        
remote: error: Changes must be made through a pull request. 5 of 5 required status checks are expected.
rclement commented 1 year ago

When using a GitHub personal access token instead of the default GITHUB_TOKEN, pushing to a protected branch works but results in an infinite loop.

rclement commented 1 year ago

As there is no way to enable branch protection and have a GitHub Action use the GITHUB_TOKEN to push to a protected branch (only way to avoid infinite loop), let's download manually the take-shots image artifact and manually update the screenshot in the repo.