https://github.com/tabhub/tabhub-card-action
A GitHub Action for creating your own TabHub cards of image type.
https://github.com/tabhub/tabhub-card-action
github-actions tabhub
Last synced: 3 months ago
JSON representation
A GitHub Action for creating your own TabHub cards of image type.
- Host: GitHub
- URL: https://github.com/tabhub/tabhub-card-action
- Owner: tabhub
- License: gpl-3.0
- Created: 2020-05-30T13:40:43.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2022-08-19T00:59:38.000Z (almost 3 years ago)
- Last Synced: 2024-12-31T09:44:58.900Z (5 months ago)
- Topics: github-actions, tabhub
- Language: JavaScript
- Homepage: https://tabhub.github.io
- Size: 39.1 KB
- Stars: 0
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# TabHub Card Action
TabHub Card Action helps you to generate your own album cards used in [TabHub Chrome Extension](https://tabhub.io).
## Usage
For example, you can put your family's photos in a repo:
1. all these images must be put under a folder named `images` that we can call it an album or resource
2. you can have several `images` folders in different directories, and a manifest json file will be generated according to one `images` folder
3. if current directory already exists an `images` folder, those `images` folders in current sub directories wouldn't be included in resultthen use this action to generate some `manifest.json`s that you can use to play these photos in a new tab of your Chrome(or Edge) browser, you can find the action will also generate a [README file](https://github.com/tabhub/tabhub-card-action/blob/master/ACTION_README_SAMPLE.md) for you that contains a list of manifest file's link.
### Add a resource manifest link in your TabHub
Copy a resource manifest link address from README file generated by the action and set it in the TabHub as below:
![]()
### Workflow Configuration
You can follow the config below to create your GitHub workflow, or just [use a template](https://github.com/tabhub/tabhub-card-action-template/generate) we provide.
```yaml
# your GitHub Action workflow config filename: Test TabHub Card Action
on: [push]
jobs:
test_tabhub_action:
runs-on: ubuntu-latest
name: A job to test TabHub action
steps:
- name: Checkout
uses: actions/checkout@v2
- name: TabHub Card Action
uses: tabhub/tabhub-card-action@master
- name: Git commit
run: |
# git commit if there's any change
if test -n "$(git status --porcelain 2>/dev/null)"; then
git config --local user.email "41898282+github-actions[bot]@users.noreply.github.com"
git config --local user.name "github-actions[bot]"
git add .
git commit -m "Update manifest"
git push
fi
```