action-issue-to-hexo's Introduction

Issue to Hexo

This action converts a GitHub Issue to a Hexo post.

Template

In converting, this action takes information of an issue and set it to information of a post as follows:

GitHub Issue	Hexo post	Action
Title	Title
Last updated date/time	Date
Labels	Tags
Body	Content
Milestone		Issue is converted only if milestone is set to `publish`

Usage

name: Issue to Hexo
on:
  issues:
    # Sufficient to trigger this workflow when an issue is milestoned
    types: [ milestoned ]
jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - uses: gsongsong/issue-to-hexo
        with:
          issue_url: ${{ github.event.issue.url }}
          # Personal access token used to get information of Issue
          token: ${{ secrets.token }}
      # At this point, a markdown file is generated and untracked
      # Take further action, e.g. generate (`hexo generate`), commit and push

Sponsor

If you feel this is useful, please consider to support me:

action-issue-to-hexo's People

Contributors

Stargazers

Watchers

action-issue-to-hexo's Issues

Issue to Hexo

Issue URL

github.event.issue.url in GitHub Actions workflow (event = issues, types = milestoned)

Lock an issue (not necessary?)

PUT github.event.issue.url/lock (with authorization)

Issue information

GET github.event.issue.url (with authorization)

Title: data.title
Update date/time: data.updated_at
Labels (tags): data.labels[].name
Milestone (whether to publish): data.milestone.title
Body: data.body

Create a post

const Hexo = require('hexo');
const hexo = new Hexo(process.cwd(), {});
hexo.init().then(() => {
    hexo.post.create({
        title: data.title,
        date: data.updated_at,
        tags: data.labels.map((label) => label.name),
        content: body,
    });    
}).catch((reason) => {
    console.error(reason);
});