A CLI to encourage (😅) people to update their dependencies!
Project description
rubrical
A CLI to encourage (😅) people to update their dependencies!
Supported package managers:
- Python (requirements.txt)
- Go (go.mod)
- Node.js (package.lock)
- Jsonnet
- More coming soon!
Installation
Package
pip install rubrical
Docker
docker pull ghcr.io/ivanklee86/rubrical:latest
docker run --rm -it --name rubrical -v `pwd`/tests/files:/code ghcr.io/ivanklee86/rubrical:latest --config /code/rubrical.yaml --target /code
Usage
$ rubrical [OPTIONS]
Options:
--config PATH
: Path to configuration [default: rubrical.yaml]--target PATH
: Path to configuration [default: /workspaces/rubrical]/--no-block
: Don't fail if blocks found. [default: True]--debug / --no-debug
: Enable debug messages [default: no-debug]--repository-name TEXT
: Repository name for reporting purposes. [env var: RUBRICAL_REPOSITORY]--pr-id INTEGER
: PR ID for reporting purposes. [env var: RUBRICAL_PR_ID; default: 0]--gh-access-token TEXT
: Github access token for reporting. Presence will enable Github reporting. [env var: RUBRICAL_GH_TOKEN]--gh-custom-url TEXT
: Github Enterprise custom url. e.g. https://github.custom.dev [env var: RUBRICAL_GH_CUSTOM_URL]--install-completion
: Install completion for the current shell.--show-completion
: Show completion for the current shell, to copy it or customize the installation.--help
: Show this message and exit.
Configuration
The rubrical.yaml
file is used to configure checks for your application.
version: 1
package_managers:
- name: jsonnet
packages:
- name: "xunleii/vector_jsonnet" # Name of the dependency
block: v0.1.0 # If dependency is less than this, error.
warn: v0.1.2 # If dependency is less than this, warn.
- name: python
packages:
- name: Mopidy-Dirble
block: v1.2.1
warn: v1.2.2
- name: go
packages:
- name: github.com/adrg/xdg
block: v0.5.0
warn: v0.6.0
- name: nodejs
packages:
- name: react
block: v17.0.3
warn: v17.0.4
Reporting
Terminal
Comes for free!
Github
- Create a Github access token with
Pull requests: Read and write
permissions. - Run rubrical with the
--gh-access-token
,--repository-name
, and--pr-id
flags.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
rubrical-0.3.0.tar.gz
(15.8 kB
view hashes)
Built Distribution
rubrical-0.3.0-py3-none-any.whl
(21.1 kB
view hashes)