https://github.com/yegor256/copyrights-action

Check the presence of copyright notices in all textual source-code files
https://github.com/yegor256/copyrights-action

copyright github-actions javascript js

Last synced: 7 months ago
JSON representation

Check the presence of copyright notices in all textual source-code files

• Host: GitHub
• URL: https://github.com/yegor256/copyrights-action
• Owner: yegor256
• License: mit
• Created: 2024-06-07T03:11:09.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2025-03-22T00:59:13.000Z (7 months ago)
• Last Synced: 2025-03-22T01:35:18.601Z (7 months ago)
• Topics: copyright, github-actions, javascript, js
• Language: JavaScript
• Homepage:
• Size: 5.44 MB
• Stars: 6
• Watchers: 2
• Forks: 0
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

          
# Check Copyrights in All Text Files

[![test](https://github.com/yegor256/copyrights-action/actions/workflows/test.yml/badge.svg)](https://github.com/yegor256/copyrights-action/actions/workflows/test.yml)

[![License](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/yegor256/copyrights-action/blob/master/LICENSE.txt)

This is a GitHub Action that checks the presence of copyright notices

in all text files in the repository. Use it like this:

```yaml

name: copyrights

on:

  push:

  pull_request:

jobs:

  copyrights:

    runs-on: ubuntu-22.04

    steps:

      - uses: actions/checkout@v4

      - uses: yegor256/copyrights-action@0.0.5

```

It will find the copyright punch line in the `LICENSE.txt` and then

will try to find its presence in all source code files. If at least one

of them doesn't have the punch line, the plugin will raise an error.

A more fine-grained configuration is also possible:

```yaml

- uses: yegor256/copyrights-action@0.0.5

  with:

    license: LICENSE.txt

    globs: >-

      **/*.java

      **/*.py

      Makefile

      **/*.xml

    ignore: >-

      target/**

      node_modules/**/*.js

```

However, it is advised to stay with the defaults.

## How to Contribute

In order to test this action, just run:

```bash

make test

```

This should build a new Docker image and then try to use it

in order to render a simple `test.tex` document. You need to have

[Docker](https://docs.docker.com/get-docker/) installed.