Skip to main content

Update deprecated command, versions, and other for GitHub actions

Project description

Action Updater

PyPI version main

docs/assets/img/logo/action-updater-small.png

All Contributors

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 ⭐️

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)

$ action-updater list-updaters

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

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

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

And finally, write updates to file!

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

🎨 Screenshots 🎨

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

docs/assets/img/detect.png

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

docs/assets/img/clean.png

Running across many files:

docs/assets/img/updates.png

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:

$ action-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
Vanessasaurus

💻

License

This code is licensed under the MPL 2.0 LICENSE.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

action-updater-0.0.15.tar.gz (35.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

action_updater-0.0.15-py3-none-any.whl (46.6 kB view details)

Uploaded Python 3

File details

Details for the file action-updater-0.0.15.tar.gz.

File metadata

  • Download URL: action-updater-0.0.15.tar.gz
  • Upload date:
  • Size: 35.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.11.3 pkginfo/1.8.3 requests/2.28.1 requests-toolbelt/0.9.1 tqdm/4.64.1 CPython/3.10.6

File hashes

Hashes for action-updater-0.0.15.tar.gz
Algorithm Hash digest
SHA256 8e1fa6f959ff90de41d86959b06fd6e3c7d3c314ba61058a885c79970af15e3b
MD5 1ab755baeb56a3b17b8c0fd4285e8461
BLAKE2b-256 40f2a4e5aedd75de659264c4155776cc35e7080b811490c4df6cbc6a55a0dcae

See more details on using hashes here.

File details

Details for the file action_updater-0.0.15-py3-none-any.whl.

File metadata

  • Download URL: action_updater-0.0.15-py3-none-any.whl
  • Upload date:
  • Size: 46.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.11.3 pkginfo/1.8.3 requests/2.28.1 requests-toolbelt/0.9.1 tqdm/4.64.1 CPython/3.10.6

File hashes

Hashes for action_updater-0.0.15-py3-none-any.whl
Algorithm Hash digest
SHA256 e64553632a64b0ae277869432ea16f0bdfbc03ffcdd84d99d95ea8ce44c4fa2b
MD5 47578c61e647d0039d184cdfd2c45746
BLAKE2b-256 21780b0a760e9ad27fee08162bd901909e7342a9a9a386d0834f252ddca5833a

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page