name: Add header

jobs:
  build:
    name: Add headers
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v4
      with:
        token: ${{ secrets.PAT }} # (only needed for private repos)
    
    - name: Add header action step
      uses: minituff/add-header-action@v1
      with: # All arguments are optional, see the defaults below
        dry-run: false # Don't make any changes, but log what *would* change.
        verbose: false # Extra logging to help you debug.
        file-name: .headerrc.yml # The name of your settings file.
      env:
        FORCE_COLOR: "1" # Optional: Shows color output in GitHub console.

    - name: Commit and Push changes back to repo
      uses: stefanzweifel/git-auto-commit-action@v5

# Choose what to do with the header.
# remove  =  Remove an existing header from matching files.
# add     =  Add the header to any matching files.
header_action: add # Default: add

# Decide the method for choosing which files to add headers to.
# opt-out  =  All files will be selected unless the file path matches untracked_files.
# opt-in   =  No files will be selected unless the file path matches anything in tracked_files.
file_mode: opt-out # Default: opt-out

# A list of regex used to match file paths to receive the header. (opt-in mode only)
tracked_files: 
  - ^README.md$

# A list of regex used to match file paths to be skipped. (opt-out mode only)
# All file paths *not* matched will receive a header.
untracked_files:
  - app/
  - ^Dockerfile$

# Automatically add everything in the .gitignore file into the untracked_files section.
# This can save lots of time because most of these files can be ignored.  (opt-out mode only)
untrack_gitignore: true # Default: true

use_default_file_settings: true # Default: true

# The header to be added. Do not add the comment (#, //) here, see the file_associations section for that.
header: |
  SUPER SECRET CONFIDENTIAL

  [2023] - [Infinity and Beyond] ACME Inc
  All Rights Reserved.
  
  NOTICE: This is super secret info that
  must be protected at all costs.

# Customize the negation character. See below for how to use this.
# Any *default* file assocation that has this character at the beginning of the (key/value) will be removed. This only works if it is matched exactly. 
negate_characters: "!" # Default: "!"

# Group mulitple items by the comment value.
file_associations_by_comment:
  "#": 
    - "^.gitignore$"
    - "!^.gitignore$" # <-- Negate default items like this
    - ".gitignore$" # <---- You can also re-add any negated items
  "//": 
    - ".js$"
    - ".ts$"

# The item extension and the assocated comment. Overrides file_associations_by_comment if duplicates.
# Remember the escape charter for yml is "\"
# Here, you can only negate items by their key
file_associations_by_extension:
  ".*\.ya?ml$": "#"
  "!.md": ["<!--", "-->"] # <--- Negate default items like this

# For files that have 'important' first lines (like bash), use this setting to move the header below that line.
# Here, you can only negate items by their key.
skip_lines_that_have:
  ".sh$": ["#!"]

untracked_files:
  - ^\.gitignore

untracked_files:
  - !^\.gitignore  <-- Negate ^\.gitignore

negate_characters: "++" # Default "!"

dry-run: false 
verbose: false
file-name: .headerrc.yml # Located in either the `.github` or *root* diretory of your project.