starlight220 / inspector

Action to automatically update Sphinx Remote Literal Includes (https://github.com/wpilibsuite/sphinxext-remoteliteralinclude)

Hi!

I'm a developer who thinks that functional programming and lambdas are cool, and tries to avoid cargo cult programming. I'm mostly self-taught, supplemented by courses at the Open University of Israel. I've also learned a lot by regularly contributing to open-source, and I'm always happy to learn more!

I'm passionate about robotics - I'm now part of the WPILib organization, which is responsible for maintaining the toolsuite for the FRC (FIRST Robotics Competition), after being the Lead Programmer of FRC team #6738 Excalibur for two years. I'm also interested in DevOps, and experienced in Gradle and GitHub Actions.

Languages, Tools, and Frameworks

Additional technologies I'm familiar with include Linux/Bash, Windows/Batch, C/C++, Rust, and Docker.

Project Portfolio

inspector's Issues

Crashes if file doesn't exist in checked version

Inspector runs and produces report but doesn't comment

Seen during this run of \inspector fix all: https://github.com/wpilibsuite/frc-docs/actions/runs/7387841236

Two possible reasons I can think of
The RLIs 404 and that causes inspector to error
There's no RLIs that can be automatically fixed (because of the 404), and since it's an empty commit it doesn't post the

Regex doesn't match files with `-` in them

Add input/output type spec

See https://github.com/krzema12/github-actions-typing

Alias Raw GitHub URLs

Add an option to treat github.com/${user}/${repository}/raw and raw.githubusercontent/${user}/${repository} URLs as aliases and detect both.

This will likely be a special format in the baseUrl config parameter, perhaps something as @github: user/repository or similar. Leaves @ syntax for expansion with more special cases later on.

Config format

So there are two options as to specifying project settings.

1. In the workflow YAML as an input/env. Any non-string types will have to be deserialized.
2. In a separate JSON file, which is loaded by ActionsKtLib. This possibly conflicts with the current mechanism for running locally (ActionsKtLib loads the inputs from a JSON file instead of from the environment variables. This gives greater freedom with types.

In the context of Inspector, these are the properties/options that will be passed:

root: String
baseUrl: String
versionScheme: String
latestVersion: String
ignoreFiles: Set<String>

Parsing either JSON or raw text isn't that problematic either way.

Doesn't pick up on multiple line ranges in same RLI

So it turns out that this is valid RLI syntax:

  :lines: a-b, c-d