License Updater

Every year I go through projects and update license strings. It's OK for a few projects but can get really arduous! Thus, I made this license updater to do exactly what I needed.

TODO

The actions updater will make it easy to update actions:

• 🥑 updated syntax and commands
• 🥑 versions of actions, either for releases or commits
• 🥑 preview, write to new file, or write in place!
• 🥑 run as a GitHub action workflow for annual checks!

You can see the ⭐️ Documentation ⭐️ for complete details!

⭐️ Quick Start ⭐️

Installation

The module is available in pypi as license-updater, and to install we first recommend some kind of virtual environment:

$ python -m venv env
$ source env/bin/activate

And then install from pypi using pip:

$ pip install license-updater

Usage

For all commands below, the actions updater can accept a directory with yaml files, or a single yaml file that matches the GitHub actions schema.

View updaters available (and descriptions)

$ license-updater list-updaters

You should likely detect (to preview) before you write the changes to file.

# Run all updaters
$ license-updater detect .github/workfows/main.yaml

# Only detect for the setoutput updater
$ license-updater detect -u setoutput .github/workfows/main.yaml

And finally, write updates to file!

$ license-updater update .github/workfows/main.yaml

🎨 Screenshots 🎨

If a file has updates, it will print to the terminal the updated file for preview.

And after you run update (described below) you will see all green!

Running across many files:

And that's it! The action comes with several updaters that will look for particular aspects to lint or update. If you have a request for a new updated, please open an issue.

Feature Ideas

This could be fairly easy to extend to allow for more "linting" style actions to reflect preferences in style, e.g:

$ license-updater lint .github/workflows/main.yaml

If this sounds interesting to you, please open an issue to discuss further! We currently do some basic linting, as the yaml loading library has preferences for saving with respect to spacing, etc.

😁️ Contributors 😁️

We use the all-contributors tool to generate a contributors graphic below.

Vanessasaurus 💻

License

This code is licensed under the MPL 2.0 LICENSE.