https://github.com/bpazy/issue-blog-action
Write blogs with 'Github Issues'. The Action helps you display your blogs on README.md.
https://github.com/bpazy/issue-blog-action
action blog issue
Last synced: about 1 month ago
JSON representation
Write blogs with 'Github Issues'. The Action helps you display your blogs on README.md.
- Host: GitHub
- URL: https://github.com/bpazy/issue-blog-action
- Owner: Bpazy
- License: gpl-3.0
- Created: 2022-11-15T16:50:01.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2023-04-06T13:56:20.000Z (about 3 years ago)
- Last Synced: 2026-04-23T12:05:16.134Z (2 months ago)
- Topics: action, blog, issue
- Language: JavaScript
- Homepage:
- Size: 198 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# issue-blog-action
Write blogs with `Github Issues`. The Action helps you display your blogs on `README.md`.
**Example preview:** [Bpazy/blog](https://github.com/Bpazy/blog#recent-blogs)
## Usage
1. First append `` and `` into your README. Like this:
```
```
2. And then create Github Actions profile like this:
```yaml
name: Update latest blog
on:
workflow_dispatch:
schedule:
- cron: '0,30 * * * *'
jobs:
build:
runs-on: ubuntu-latest
name: Update latest blog
steps:
- uses: actions/checkout@v3
- uses: Bpazy/issue-blog-action@v1.0.2 # Bpazy/issue-blog-action@master for beta
with:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
```
| All inputs | Description | Default |
|----------------|-----------------------------------------------------------------------|----------------------------------------------|
| GITHUB_TOKEN | Token for commit file. Should always be `${{ secrets.GITHUB_TOKEN }}` | ${{ secrets.GITHUB_TOKEN }} |
| GITHUB_EMAIL | Your Github name, used to commit when Github Action running | |
| GITHUB_NAME | Your Github email, used to commit when Github Action running | |
| COMMIT_MSG | Message when update issue activity | Update README with the recent issue activity |
| NUMBER | Issues number. Max: 100 | 20 |
| SUMMARY_LENGTH | Summary default char length | 100 |
| OWNER | Github owner | Current owner |
| REPO | Github repo | Current repo |
## Development dependency
```sh
npm install -g @vercel/ncc
npm install
npm run compile
```