This GitHub Action will allow you to track how well a repository is keeping up-to-date with NPM dependencies, using libyear.
This action is powered by the NPM package by the same name: libyear.
It can be used in combination with other actions to generate badges (see below).
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 rather than
develop to avoid future breaking changes with your workflow.
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@developAll configuration options are passed in via env, as environment variables. For example:
jobs:
deploy:
# ...
- uses: s0/libyear-node-action@develop
env:
FOLDER: some/sub/directory| Env Variable | Description | Required? |
|---|---|---|
FOLDER |
Which directory within your repository should libyear be run in. (Default: root of repository) |
No |
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.
| 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 |
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 and
s0/git-publish-subdir-action
in addition to this action.
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: trueWe use this for this repository, you can see the workflow here:
badges.yml
Please see the issues for details of planned work.