michakfromparis / ci-detective

Dumps clear info on the repo state πŸ”Ž, runner state, github variables, tags & versions to make sure you can read your logs easily. Typical executes at the begining of your workflow, right after your checkout action. Works well with self-hosted runners. Made with ❀️ ...and suspicion πŸ•΅οΈ

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

πŸ•΅οΈ CI Detective

πŸ’»πŸ” Get ready to geek out with this ultimate repo diagnostic tool! πŸ”¬

Introducing the Build Info Detective πŸ’₯ It's like a super-sleuth for your GitHub repos, providing you with crystal clear information on the state of your repo, runner, GitHub variables, and more! πŸ”Ž

With this handy tool, you'll be able to keep a close eye on the pulse of your repos, easily checking on tags and versions, and making sure everything is running smoothly. πŸ’»

And the best part? It's super easy to use! Simply run it at the start of your workflow, right after you've checked out your code. πŸš€

Perfect for those using self-hosted runners, the Repo State Dumper is the ultimate way to keep your repos healthy, efficient, and always running like clockwork. πŸ•°οΈπŸ’₯

Inputs

inspect-system

[Optional] prints system info. Defaults to true.

inspect-git

[Optional] prints git info. Defaults to true.

inspect-github-environment

[Optional] prints the value of the github environment variables. Defaults to false.

inspect-environment

[Optional] prints the value of the environment variable names separated by a comma. See example usage.

inspect-package-json

[Optional] prints name and version from package.json and compares version with tag version. Defaults to false unless package.json present at root of repository.

package-json-path

[Optional] set the full path to package.json Defaults to root of repository.

Example usage

Inspect system & git info.

uses: michakfromparis/ci-detective@1.1.0

Inspect git info only.

uses: michakfromparis/ci-detective@1.1.0
with:
  inspect-system: false
  inspect-git: true

Inspect system info, git info and the ENVIRONMENT, APP_ENV & CONFIGURATION variables.

uses: michakfromparis/ci-detective@1.1.0
with:
  inspect-environment: 'ENVIRONMENT, APP_ENV, CONFIGURATION'

Inspect system info, git info & package. name, version from package.json. If on a version tagged branch, compare the version with the tag version.

uses: michakfromparis/ci-detective@1.1.0
with:
  inspect-package-json: true

If on a monorepo, specify the full path to package.json.

uses: michakfromparis/ci-detective@1.1.0
with:
  inspect-package-json: true
  package-json-path: workspace/front/package.json

About

Dumps clear info on the repo state πŸ”Ž, runner state, github variables, tags & versions to make sure you can read your logs easily. Typical executes at the begining of your workflow, right after your checkout action. Works well with self-hosted runners. Made with ❀️ ...and suspicion πŸ•΅οΈ


Languages

Language:Shell 92.0%Language:Dockerfile 8.0%