validate-python-headers

An action to validate the headers of your Python files

APACHE-2.0 License

Stars
3
Committers
1
View Code on GitHub View on X
Ecosystems: Python
validate-python-headers - v0.5.0 Latest Release

Published by frgfm 4 months ago

This minor release improves the remediation message and speeds up the action.

Highlights

Better remediation 🔈

When any header was invalid, we were showing you one of the accepted headers. Let's say you created a file in 2020, your organization is named Pyronear and you picked the Apache 2 license. Now we're in 2024, you would have received this message:

Your header should look like:

# Copyright (C) 2023-2024, Pyronear.

# This program is licensed under the Apache License 2.0.

this is not correctly updated to:

Your header should look like:

# Copyright (C) <FILE_CREATION_YEAR>-2024, Pyronear.

# This program is licensed under the Apache License 2.0.

Python 3.11 ⚡

We upgrade the python version from 3.8 to 3.11 for the action's docker which should save you some CI minutes!

What's Changed

New Features 🚀

Improvements

Full Changelog: https://github.com/frgfm/validate-python-headers/compare/v0.4...v0.5.0

validate-python-headers - v0.4: Adds a new option for custom license notice

Published by frgfm almost 2 years ago

This minor release adds the possibility to have a custom license notice.

Highlights

Custom license notice 🤫

When developing software, you might sometimes not be able to share your work in open source. This is understandable and implies that you have a custom license notice. This release allows you to do so:

uses: frgfm/validate-python-headers@main
with:
  owner: 'François-Guillaume Fernandez'
  starting-year: 2022
  license-notice: '.github/license-notice.txt'
  ignore-folders: '.github/'

Enjoy!

What's Changed

New Features 🚀

Improvements

Full Changelog: https://github.com/frgfm/validate-python-headers/compare/v0.3...v0.4

validate-python-headers - v0.3: Adds a new option to ignore folders

Published by frgfm almost 2 years ago

This minor release adds the possibility to ignore folders & renames a previous option.

Highlights

Folder ignoring 🙈

Until now you could ignore files, but let's be honest: most tools allow you to ignore folders. While patterns are not supported yet, one feature was added to ignore entire folders:

uses: frgfm/validate-python-headers@main
with:
  license: 'Apache-2.0'
  owner: 'François-Guillaume Fernandez'
  starting-year: 2022
  ignore-folders: '.github/'

Enjoy!

Tighter cleaning 🧹

In order to improve the quality of the project, the following tools were added:

  • autoflake: to automatically apply flake8
  • bandit: spots vulnerabilities in the code

Additionally, precommit hooks were added to minimize the forth-and-forth with the CI and have clean commits upfront 😄

Breaking changes

Renamed parameter

The ignores option was renamed into ignore-files to have a more explicit naming and better align with new features. The following action:

uses: frgfm/validate-python-headers@main
with:
  license: 'Apache-2.0'
  owner: 'François-Guillaume Fernandez'
  starting-year: 2022
  ignores: '__init__.py,version.py'

now needs to be modified as follows if you use the latest version:

uses: frgfm/validate-python-headers@main
with:
  license: 'Apache-2.0'
  owner: 'François-Guillaume Fernandez'
  starting-year: 2022
  ignore-files: '__init__.py,version.py'

What's Changed

Breaking Changes 🛠

New Features 🚀

Bug Fixes 🐛

Improvements

Full Changelog: https://github.com/frgfm/validate-python-headers/compare/v0.2...v0.3

validate-python-headers - v0.2: Added support for all SPDX licenses

Published by frgfm over 2 years ago

This minor release fixes the Docker orchestration of the action and adds support for all SPDX-referenced licenses.

Highlights

Broad support of licenses 📖

Instead of manually adding the reference for all licenses, this release adds support for all SPDX-referenced licenses using their identifier. This should help for various projects with their own license requirements.

Minimal effort, insightful report 🤓

The action was designed to have minimal input from the user, as shown below:

uses: frgfm/validate-python-headers@main
with:
  license: 'Apache-2.0'
  owner: 'François-Guillaume Fernandez'
  starting-year: 2022
  ignores: 'version.py,__init__.py'

Using this in your workflow will allow you to have a wary assistant for your headers 🙌

What's Changed

New Features 🚀

Bug Fixes 🐛

Improvements

Full Changelog: https://github.com/frgfm/validate-python-headers/compare/v0.1...v0.2

validate-python-headers - v0.1: Header validator for your Python files

Published by frgfm over 2 years ago

This minor release provides a light GitHub action to check your Python headers for copyright and license notices.

Highlights

License check ✔️

Using the license identifier, the action will automatically fetch the full license name and its URL so that your headers include all necessary mentions for your project to be correctly licensed.

Dynamic copyright year ⏳

Complex projects have parts that have been designed years apart. This means that your code may have different starting copyright years and needs to be incorporated as such in the header. You only have to specific the starting year of your project, the action will take care of the rest 👍

What's Changed

New Features 🚀

New Contributors

Full Changelog: https://github.com/frgfm/validate-python-headers/commits/v0.1.0

Package Rankings
Top 13.69% on Github actions