peaceiris / actions-suggest-related-links

A GitHub Action to suggest related or similar issues, documents, and links. Based on the power of NLP and fastText.

About Me

I'm peaceiris, interested in Static Site Generators and GitHub Actions.

• peaceiris homepage
• GitHub Action Hero: Shohei Ueda - The GitHub Blog

Projects

• peaceiris/actions-gh-pages
• peaceiris/actions-hugo
• peaceiris/actions-mdbook
• peaceiris/actions-label-commenter
• peaceiris/emoji-ime-dictionary

Also, I spend my time on various repositories and forums to support communities.

actions-suggest-related-links's Issues

test new suggestion message style

Description

Currently, all files that are set to be ignored in .gitignore will not be deployed by the action. This seems to be caused by the git clone operation and, while I haven't been able to find any discussion on this in issues or PRs (I used github's search tool, so I might be on the wrong here), I think it's safe to assume that this is the intended behaviour.

I believe that this behaviour could be counterintuitive to some users, so it may be interesting to document it on the readme, or at least discuss the idea here.

Reproduction

1. Create a repository that includes a .gitignore file that blacklists some files
2. Set up a CI pipeline that deploys the directory that contains the .gitignore file using this action
3. Files specified on .gitignore will not be deployed

You can see this behaviour on this CI run.

Reasons why this can be unexpected

I personally got confused by this behaviour, as I expected .gitignored files to be deployed. My thought process went along the lines of:

1. People usually deploy build artifacts
2. Build artifacts are usually excluded from git through .gitignore
3. Thus, .gitignore files are probably not ignored when deploying

test unclickable false

Description

Currently, all files that are set to be ignored in .gitignore will not be deployed by the action. This seems to be caused by the git clone operation and, while I haven't been able to find any discussion on this in issues or PRs (I used github's search tool, so I might be on the wrong here), I think it's safe to assume that this is the intended behaviour.

I believe that this behaviour could be counterintuitive to some users, so it may be interesting to document it on the readme, or at least discuss the idea here.

Reproduction

1. Create a repository that includes a .gitignore file that blacklists some files
2. Set up a CI pipeline that deploys the directory that contains the .gitignore file using this action
3. Files specified on .gitignore will not be deployed

You can see this behaviour on this CI run.

Reasons why this can be unexpected

I personally got confused by this behaviour, as I expected .gitignored files to be deployed. My thought process went along the lines of:

1. People usually deploy build artifacts
2. Build artifacts are usually excluded from git through .gitignore
3. Thus, .gitignore files are probably not ignored when deploying

Composite workflow

Use ghapi for local testing

Is your feature request related to a problem? Please describe

• fastai/ghapi: A delightful and complete interface to GitHub's amazing API
• Learn about ghapi, a new third-party Python client for the GitHub API - The GitHub Blog

Describe the solution you'd like

Describe alternatives you've considered

Additional context

test unclickable true

Description

Currently, all files that are set to be ignored in .gitignore will not be deployed by the action. This seems to be caused by the git clone operation and, while I haven't been able to find any discussion on this in issues or PRs (I used github's search tool, so I might be on the wrong here), I think it's safe to assume that this is the intended behaviour.

I believe that this behaviour could be counterintuitive to some users, so it may be interesting to document it on the readme, or at least discuss the idea here.

Reproduction

1. Create a repository that includes a .gitignore file that blacklists some files
2. Set up a CI pipeline that deploys the directory that contains the .gitignore file using this action
3. Files specified on .gitignore will not be deployed

You can see this behaviour on this CI run.

Reasons why this can be unexpected

I personally got confused by this behaviour, as I expected .gitignored files to be deployed. My thought process went along the lines of:

1. People usually deploy build artifacts
2. Build artifacts are usually excluded from git through .gitignore
3. Thus, .gitignore files are probably not ignored when deploying

Support exempt-labels and only-labels input option

Is your feature request related to a problem? Please describe

  exempt-issue-labels:
    description: 'The labels to apply when an issue is exempt from being marked a target of suggesting. Separate multiple labels with commas (eg. "label1,label2")'
    default: ''
  only-labels:
    description: 'Only issues with all of these labels are the target of suggesting. Defaults to `[]` (disabled) and can be a comma-separated list of labels.'
    default: ''

Describe the solution you'd like

      - uses: peaceiris/actions-suggest-related-links@v1
        with:
          exempt-issue-labels: 'proposal'

Describe alternatives you've considered

N/A

Additional context

• https://github.com/actions/stale/blob/1849651e2aa1b1d6d2cba4c90c719f4b6c929a28/action.yml

Support edited event

Is your feature request related to a problem? Please describe

on:
  issues:
    types:
      - opened
      - edited

Describe the solution you'd like

When the edited event is triggered, suggested links are updated.

Describe alternatives you've considered

N/A

Additional context

Blocked by community/community#4350