Auto Issue List in README

Display issues on the landing page 👀

Demo

The issue list below...

list style：

1. more test
2. test

or table style:

Title	Status	Assignee	Body
more test	✳️		yay!
test	✳️		test hoge testtest ...

is compiled through this action.

# setup
steps:
  - name: checkout
    uses: actions/checkout@v2
  - name: rewriteReadme
    uses: zhang0ZGC/issue-list-readme@master
    with:
      GITHUB_TOKEN: '${{ secrets.GITHUB_TOKEN }}'
      pattern: '<!-- issueTable -->' # suffixing "Demo" for this readme
      labels: 'good first issue'
      state: 'open'
# you need to add, commit and push here
# otherwise the changes will not be pushed back into master

Usage

1. Place two identifiers in your README.md, which the action detects as the location to inject the issue list to.

README.md

//
// your contents
//

// place two identifiers

<!-- issueTable -->

<!-- issueTable -->

//
// your another contents
//

2. Add some issues. You can optionally use the same identifier to extract a part the body to display in the list.

Some issue

// place two identifiers (optional)

<!-- issueTable -->

<!-- issueTable -->

//
// your comment
//

3. Then, write the following section into your action.

uses: seed-of-apricot/[email protected]
with:
  GITHUB_TOKEN: '${{ secrets.GITHUB_TOKEN }}'

The action will fetch the issues in the repository and re-write the README.md 👍
The body will show up to three first lines of the body (or the extracted part of it).

It is recommended to run this action on issue open/close or by a cron job (e.g., cron: "0 0 * * *").

Options

Available variables are:

variable	required	default	note
GITHUB_TOKEN	true	-	you can use ${{ secrets.GITHUB_TOKEN }}
layout	true	"list"	use list or the original table layout. One of list or table
pattern	false	"<!-- issueTable -->"	the identifier to inject the issue list and extract the body of each issue
labels	false	-	comma-separated labels to filter issues. Example: bug,ui,@high
state	false	"all"	state of the issues to filter them. Can be either open, closed, or all.
creator	false	-	The user that created the issue.
sort	false	-	What to sort results by. Can be either created, updated, comments.
direction	false	-	One of asc (ascending) or desc (descending)
since	false	-	Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ .
per_page	false	-	Results per page (max 100).
page	false	-	Page number of the results to fetch.
milestone	false	-	If an integer is passed, it should refer to a milestone by its number field. If the string * is passed, issues with any milestone are accepted. If the string none is passed, issues without milestones are returned.

REF: https://docs.github.com/cn/rest/reference/issues#list-repository-issues

Limitations

You must have README.md (not README) to make this work. (todo)

License

MIT License. This repository uses the typescript-action template so the original MIT license also applies.