Skip to content

serokell/xrefcheck-action

Use this GitHub action with your project
Add this Action to an existing workflow or create a new one
View on Marketplace

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

22 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

GitHub Action for xrefcheck

REUSE status

This repository contains a GitHub action that simplifies the usage of the xrefcheck tool.

Usage

By default this action installs the latest version of xrefcheck (it downloads a static binary from GitHub releases) and runs it with no arguments.

Inputs

Please refer to action.yml for a full list of inputs. Quick overview:

  • xrefcheck-version lets you pick a specific version.
  • xrefcheck-args lets you pass custom arguments.
  • action can be set to install if just want to install the tool and then use it manually. This functionality is experimental and maybe be reworked later.

Outputs

xrefcheck-path output will contain a relative path to the xrefcheck executable. In a future version it may contain an absolute path.

Example

To run xrefcheck-0.2.2 on your repository in the local-only mode:

jobs:
  xrefcheck:
    name: Check references
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v4
    - uses: serokell/xrefcheck-action@v1
      with:
        xrefcheck-version: 0.2.2
        xrefcheck-args: --mode local-only

Supported xrefcheck versions

  • 0.1.2
  • 0.1.3
  • 0.2
  • 0.2.1
  • 0.2.2: requires xrefcheck-action v1.0.3 or greater

Updating supported versions

When a new xrefcheck version is released and you want it to be supported by this action, do the following:

  1. Add one more check to CI.
  2. Update the list of supported versions above. Optional: update the above example to use the latest version.
  3. If necessary (e. g. if xrefcheck is distributed differently), update implementation of this action. If you do it, a new version of this action should be created, which means that a new tag should be pushed. If there is more than one tag referring to some version, such as v1 and v1.0.1, some tag may have to force-pushed.

For Contributors

Please see CONTRIBUTING.md for more information.

About Serokell

Xrefcheck and this repository are maintained and funded with ❤️ by Serokell. The names and logo for Serokell are trademark of Serokell OÜ.

We love open source software! See our other projects or hire us to design, develop and grow your idea!