option to commit .github files

[pawsong]

Thank you for sharing this good project :)

Is your feature request related to a problem? Please describe.
In some use cases, we want to commit .github workflow files so that we can trigger actions on gh-pages branch.

Describe the solution you'd like
An option to determine if .github files to commit or not.

Describe alternatives you've considered
I made a commit to disable .github filtering, but I know this is a temporary workaround.

specup@9cb1a7c

[peaceiris]

Adding a new option exclude_files may be a good solution. I will think about the details.

• .git should be always included in exclude_files.
• Default: .git .github
• When we set the option: .git file1 file2 ...

- name: Deploy
  uses: peaceiris/actions-gh-pages@v3
  with:
    github_token: ${{ secrets.GITHUB_TOKEN }}
    exclude_files: |
      .env
      .nvmrc

• Why we should not add the .github to the gh-pages branch by default?
  • We have this case publish_dir: ./

[pawsong]

If .git should be always excluded, then how about excluding .git regardless of exclude_files option?

Then default value of exclude_files would be .github.

[pawsong]

Setting default value of exclude_files to .github or .git .github... both options look reasonable to me.

[peaceiris]

Yes. We can exclude .git from a publish directory regardless of the exclude_files and define .github as a default value of the exclude_files option.

inputs:
  exclude_files:
    description: 'Set files to exclude from a publish directory.'
    required: false
    default: '.github'

[peaceiris]

To mean that the option has files or directories, we should probably call it exclude_assets.

inputs:
  exclude_assets:
    description: 'Set files or directories to exclude from a publish directory.'
    required: false
    default: '.github'

[pawsong]

How to exclude only files under .git directory? Possibly we can set exclude_assets to false or empty string ('').

[pawsong]

- name: Deploy
  uses: peaceiris/actions-gh-pages@v3
  with:
    github_token: ${{ secrets.GITHUB_TOKEN }}
    exclude_assets: false

Using false looks prettier for me.

[peaceiris]

Some users can have files that are named false or true, so I think empty is better.

[pawsong]

I agree with you. Using empty string is better.

[Legion2]

Why not excluding all files and directories starting with . by default. Because they are considered invisible.

[pawsong]

Excluding all dot files will be a breaking change for existing users.

[Legion2]

But else we have to discuss what is excluded by default. There are many dot files like the .gitignore you don't need to deploy to github pages. The simplest solution is to never deploy the root of the git repo, because it contains many configuration files.