AutoCopyright is an open-source Continuous Integration (CI) project designed to automate the addition of copyright notices in code files.
AutoCopyright is a lightweight tool that seamlessly integrates with GitHub Actions. It utilizes YAML (YML) configuration files and automatically add a copyright notice at the end of each files.
To set up AutoCopyright for your project, follow these steps:
- Place the
utils
folder and the.github
folder at the root of your project. - Configure the list of files and folders to
exclude
insideutils/addCopyright.py
. - Ensure to set the copyright_comment var inside
utils/addCopyright.py
.
- On GitHub, open your repository.
- Go to
Settings
. - Then drop
Actions
to openGeneral
. - In
Workflow permissions
, toggleRead and write permissions
. - Then, enable
Allow GitHub Actions to create and approve pull requests
. - Don't forget to click on
Save
button below.
That's it! With these simple setup instructions, AutoCopyright will handle the rest, keeping your file up to date with each commit.
If you would like to contribute to this project, please follow these guidelines:
- Fork the repository
- Create a new branch:
git checkout -b my-feature
- Make your changes and commit them:
git commit -am 'Add some feature'
- Push the branch to your forked repository:
git push origin my-feature
- Submit a pull request
This project is licensed under the MIT License. See the LICENSE file for more information.