https://github.com/seed-of-apricot/issue-list-readme

Display issues on the landing page 👀
https://github.com/seed-of-apricot/issue-list-readme

automation cicd issue-management issue-tracker issue-tracking-system project-management workflow

Last synced: 3 months ago
JSON representation

Display issues on the landing page 👀

• Host: GitHub
• URL: https://github.com/seed-of-apricot/issue-list-readme
• Owner: seed-of-apricot
• License: other
• Created: 2020-03-29T02:01:50.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-12-15T02:21:51.000Z (11 months ago)
• Last Synced: 2024-05-28T21:42:09.689Z (6 months ago)
• Topics: automation, cicd, issue-management, issue-tracker, issue-tracking-system, project-management, workflow
• Language: TypeScript
• Homepage:
• Size: 165 KB
• Stars: 12
• Watchers: 2
• Forks: 9
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
![rewriteReadme](https://github.com/seed-of-apricot/issue-list-readme/workflows/rewriteReadme/badge.svg)

# Auto Issue List in README

Display issues on the landing page :eyes:

## Demo

The issue list below...

| Title                                                                                 |         Status          |                                                            Assignee                                                             | Body                                  |

| :------------------------------------------------------------------------------------ | :---------------------: | :-----------------------------------------------------------------------------------------------------------------------------: | :------------------------------------ |

| more test | :eight_spoked_asterisk: |                                                                                                                                 | yay!                                  |

| test      | :eight_spoked_asterisk: |  | test
hoge
testtest
... |

is compiled through this action.

```yml

# setup

steps:

  - name: checkout

    uses: actions/checkout@v2

  - name: rewriteReadme

    uses: seed-of-apricot/[email protected]

    with:

      GITHUB_TOKEN: '${{ secrets.GITHUB_TOKEN }}'

      pattern: '' # 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.

```md

README.md

//

// your contents

//

// place two identifiers

//

// 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.

```md

Some issue

// place two identifiers (optional)

//

// your comment

//

```

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

```yml

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 :thumbsup:  

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 }}                                           |

| pattern      | false    | "\