package
0.0.0-20240903033607-939890176fa6
Repository: https://github.com/ossf/package-feeds.git
Documentation: pkg.go.dev

# README

Feeds

Each of the feeds have their own implementation and support their own set of configuration options.

Configuration options

packages this configuration option is only available on certain feeds, check the README of the feed you're interested in for information on this.

poll_rate this allows for setting the frequency of polling for this specific feed. This is supported by all feeds. The value should be a string formatted for duration parser. Setting this value will enable the scheduled polling regardless of the value of timer in the root of the configuration.

Example

Poll Pypi every 5 minutes

feeds:
- type: pypi
  options:
    poll_rate: "5m"

Poll npm every 10 minutes and crates every hour

feeds:
- type: npm
  options:
    poll_rate: "10m"
- type: crates
  options:
    poll_rate: "1h"

Poll a subset of pypi every 10 minutes

feeds:
- type: pypi
  options:
    packages:
    - numpy
    - django
    poll_rate: "10m"

# Packages

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
package packagist fetches packages updates from the API and static files from packagist for getting the version information.
No description provided by the author
No description provided by the author

# Functions

No description provided by the author
No description provided by the author
NewArtifact creates a Package object with the artifact ID field populated.
Creates a LossyFeedAlerter, capable of tracking packages and identifying potential loss in feeds using RSS style APIs.
NewPackage creates a Package object without the artifact ID field populated.

# Constants

No description provided by the author

# Variables

No description provided by the author

# Structs

General configuration options for feeds.
No description provided by the author
Marshalled json output validated against package.schema.json.
No description provided by the author
No description provided by the author

# Interfaces

No description provided by the author