Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/s0/libyear-node-action
Track NPM dependency freshness, and calculate how pull requests will impact this
https://github.com/s0/libyear-node-action
actions dependencies github-action github-actions libyear nodejs
Last synced: 7 days ago
JSON representation
Track NPM dependency freshness, and calculate how pull requests will impact this
- Host: GitHub
- URL: https://github.com/s0/libyear-node-action
- Owner: s0
- License: gpl-3.0
- Created: 2021-05-13T13:43:49.000Z (over 3 years ago)
- Default Branch: develop
- Last Pushed: 2024-05-17T10:44:32.000Z (6 months ago)
- Last Synced: 2024-10-07T21:48:39.209Z (about 1 month ago)
- Topics: actions, dependencies, github-action, github-actions, libyear, nodejs
- Language: TypeScript
- Homepage:
- Size: 512 KB
- Stars: 8
- Watchers: 1
- Forks: 5
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Node dependency libyear stats & PR checks
[](https://codecov.io/gh/s0/libyear-node-action)     
This GitHub Action will allow you to track how well a repository is keeping
up-to-date with NPM dependencies, using [libyear](https://libyear.com/).
This action is powered by the NPM package by the same name:
[libyear](https://www.npmjs.com/package/libyear).
It can be used in combination with other actions to generate badges (see below).
## Usage
Simply include the action `s0/libyear-node-action` in the appropriate point in
your workflow, and pass in the required configuration options:
*Note: For best results,
it is recommended you install your NPM using your preferred package manager
before running this action*
**Note: We recommend using the
[latest release](https://github.com/s0/libyear-node-action/releases) rather than
`develop` to avoid future breaking changes with your workflow.
```yml
jobs:
deploy:
name: Deploy
runs-on: ubuntu-latest
steps:
# Any prerequisite steps
- uses: actions/checkout@master
- run: npm install
# Calculate libyear
- uses: s0/libyear-node-action@develop
```
## Configuration
All configuration options are passed in via `env`, as environment variables. For example:
```yml
jobs:
deploy:
# ...
- uses: s0/libyear-node-action@develop
env:
FOLDER: some/sub/directory
```
### Full list of variables
| Env Variable | Description | Required? |
| ------------------ | ------------------------------------------------------------------------------------------------ | ------------- |
| `FOLDER` | Which directory within your repository should `libyear` be run in. (Default: root of repository) | No |
## Outputs
This action generates outputs that can be used in later steps or outputs
*(for example to generate badges to display in your README, see below)*.
The following outputs are generated.
Each of them represents a
[metric from libyear](https://github.com/jdanil/libyear#metrics).
| Output | Description |
| ---------- | ----------------------------------------------------- |
| `drift` | A floating-point number with 2 decimal places |
| `pulse` | A floating-point number with 2 decimal places |
| `releases` | An integer |
| `major` | An integer |
| `minor` | An integer |
| `patch` | An integer |
### Example: Generating badges using libyear stats
Here's an example workflow that will generate a badge for you and push it to
a special branch that can be referenced in e.g. your README.
It uses the actions
[`emibcn/badge-action`](https://github.com/emibcn/badge-action) and
[`s0/git-publish-subdir-action`](https://github.com/s0/git-publish-subdir-action)
in addition to this action.
```yml
name: Generate Badges
on:
# Run on pushes to your main branch
push:
branches:
- develop
# Run every day
schedule:
- cron: "0 0 * * *"
jobs:
get-badges:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@master
- name: Use Node.js
uses: actions/setup-node@v1
with:
node-version: 10.x
# Install dependencies and run libyear
# (notice how the libyear step has an id, this is referenced later)
- run: npm install
- id: libyear
uses: s0/libyear-node-action@develop
# Generate a badge and store it in the badge/directory
- run: mkdir badges
- uses: emibcn/badge-action@v1
with:
label: 'libyear'
# Here is where we use the output from the libyear step
status: ${{ steps.libyear.outputs.drift }} year(s) behind
color: 'blue'
path: 'badges/drift.svg'
# Upload the directory "badge" as a branch "badge" on the same repo
- uses: s0/git-publish-subdir-action@develop
env:
REPO: self
BRANCH: badges
FOLDER: badges
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
SQUASH_HISTORY: true
```
We use this for this repository, you can see the workflow here:
[`badges.yml`](.github/workflows/badges.yml)
## TODO
Please see the [issues](https://github.com/s0/libyear-node-action/issues) for
details of planned work.