seed-of-apricot / issue-list-readme Goto Github PK

View Code? Open in Web Editor NEW

12.0 2.0 9.0 169 KB

Display issues on the landing page 👀

License: Other

TypeScript 95.47% JavaScript 4.53%

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

issue-list-readme's Introduction

issue-list-readme's People

Contributors

Stargazers

Watchers

Forkers

colameo gamefiend oddcc manishram zhang0zgc developerfred fabio-morais itshypax

issue-list-readme's Issues

cannot find README.md

Currently trying to use this in my branch, and it has trouble finding the README.md file, which is located in my base directory.
my yaml file:

name: "calendar-view"

on:
    push:
    issues:
      types: [opened, edited, deleted]
      
    
jobs: 
    issue-list:
        runs-on: ubuntu-latest
        steps:
          - name: Dump GitHub context
            env:
              GITHUB_CONTEXT: ${{ toJson(github) }}
            run: echo "$GITHUB_CONTEXT"
          - name: update
            uses: seed-of-apricot/[email protected]
            with:
                GITHUB_TOKEN: '${{ secrets.GITHUB_TOKEN }}'
          - name: add-and-commit
            uses: EndBug/add-and-commit@v4
            with:
                  message: README.md has been re-written
            env:
                  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          - name: push
            uses: ad-m/github-push-action@master
            with:
                github_token: ${{ secrets.GITHUB_TOKEN }}
                branch: ${{ github.head_ref }}

in github actions, the error I am getting:

Run seed-of-apricot/[email protected]
Initializing.
GitHub client has been initialized.
Error: ENOENT: no such file or directory, open './README.md'

I played around with displaying the branch information etc (as you can see in Dump GitHub context) and trying to set the base directory with uses: working_directory:, both unhelpful. I am doublechecking again to confirm the README file has an .md end. Any ideas?

more test

yay!

test

test
hoge
testtest
yay

Nothing is added to README.md

It looks everything's fine in my job but no open issues are being added to my README.me: https://github.com/mahdi/pokespeare

Issue identifier is not optional

Error:

Action code:

name: Test

on:
  issues:
    types: [opened, closed, reopened, deleted]

jobs:
  issue-list:
    runs-on: ubuntu-latest

    permissions:
          contents: write
          pull-requests: write

    steps:
      - name: checkout
        uses: actions/checkout@v2

      - name: rewriteReadme
        uses: seed-of-apricot/[email protected]
        with:
          GITHUB_TOKEN: '${{ secrets.GITHUB_TOKEN }}'
          pattern: '<!-- issuesTable -->'
          labels: 'good first issue'
          state: 'all'
  
      - name: add-and-commit
        uses: EndBug/add-and-commit@v4
        with:
          message: README.md has been re-written by Github Actions.
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
  
      - name: push
        uses: ad-m/github-push-action@master
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}

Partial solution:

Add the identifier to each issue.

Syntax Typo in README.md

There is a typo error(marked as bold below):

with:
GITHUB_TOKEN: '${{ secrets.GITHUB_TOKEN }}'
pattern: '' # suffixing "Demo" for this readme
labels: 'good first issue'
labels: 'open'

label should be replaced with status

Extract issue titles only

Is it possible to extract only a list of issues titles (without body status etc.)?

test2

test
hoge

testtest
yay

Getting file not found error when README.md exists.

Error: ENOENT: no such file or directory, open './README.md'

My README.md file

Allow edit table headers and columns

AS A user
I WANT TO be able to configure the table headings and also which columns will be displayed
SO THAT I can use any language for the heading titles and also hide a column, for example body

Acceptance criteria

A configuration that allow us to set the "display" and "text" properties of the headings as following:

DEFAULT

with:
  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
  labels: ''
  state: 'all'
  titleHeading: 'Title'
  statusHeading: 'Status'
  assigneeHeading: 'Assignee'
  bodyHeading: 'Body'
  titleDisplay: true
  statusDisplay: true  
  assigneeDisplay: true
  bodyDisplay: true

USAGE

with:
  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
  titleHeading: 'My custom title'
  assigneeDisplay: false
  bodyDisplay: false

Result is the follow table:

My custom title	Status
Issue title	✳️
Another issue	✳️

README.md not updated

Hi i tried the steps and the job also worked correctly in workflow logs but i dont see my README updated.
I only gave access to repo option in secret generation. Is some more permission needs to be given?

https://github.com/apgapg/pie_chart/runs/572801733

Remove unused `state` variable

Using state errors here: https://github.com/sdslabs/ideas/runs/1045748738?check_suite_focus=true