# openshift-stale-artifact-inspector

> > Disclaimer: use at your own risk! This is very hardcoded and roughly done.

Latest version **2.0.1** (published 2019-05-22) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install openshift-stale-artifact-inspector
pnpm add openshift-stale-artifact-inspector
yarn add openshift-stale-artifact-inspector
bun add openshift-stale-artifact-inspector
```

Provides the command `oc-clean-stale-artifacts`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.1 |
| Published | 2019-05-22 |
| First published | 2019-04-02 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 9 |
| Unpacked size | 14.4 KB |
| Known vulnerabilities | 0 (+24 in 1 direct dependencies) |
| Install scripts | no |
| Maintainers | patricksimonian |

## Links

- npm: https://www.npmjs.com/package/openshift-stale-artifact-inspector
- Repository: https://github.com/patricksimonian/openshift-stale-artifact-inspector
- Homepage: https://github.com/patricksimonian/openshift-stale-artifact-inspector#readme
- Issues: https://github.com/patricksimonian/openshift-stale-artifact-inspector/issues
- npm.io page: https://npm.io/package/openshift-stale-artifact-inspector

## Dependencies (9)

- [axios](https://npm.io/package/axios.md) ^0.18.0
- [chalk](https://npm.io/package/chalk.md) ^2.4.2
- [dotenv](https://npm.io/package/dotenv.md) ^7.0.0
- [figlet](https://npm.io/package/figlet.md) ^1.2.1
- [minimist](https://npm.io/package/minimist.md) ^1.2.0
- [progress](https://npm.io/package/progress.md) ^2.0.3
- [cli-spinner](https://npm.io/package/cli-spinner.md) ^0.2.10
- [@octokit/rest](https://npm.io/package/@octokit/rest.md) ^16.18.1
- [openshift-client](https://npm.io/package/openshift-client.md) ^3.10.8

## Recent versions

- 2.0.1 (latest) — 2019-05-22
- 2.0.0 — 2019-05-22
- 1.3.0-0 — 2019-04-02

## README

## PR CLEANER

> Disclaimer: use at your own risk! This is very hardcoded and roughly done.

This project was made so that I could quickly interface with openshift cli and github to clean up open shift artifacts that were generated from the OCP-CD/CI Pipeline. There are many situations
in which the development namespace gets littered with artifacts that eat resources. 

## How to get started

### Prerequisites

- NodeJS 10
- jq v1.5 `brew install jq` in mac osx `sudo apt-get update sudo apt-get install jq` in linux
- oc cli v3.11 (open shift cli)

### As a CLI
1. `npm install -g openshift-stale-artifact-inspector`
2.  run with cmd `oc-clean-stale-artifacts -h`
3.  you can run the tool with inline arguments or a json configuration file
```json
// config.json
{
  "app": "devhub-dev",
  "dev": "devhub-dev",
  "test": "devhub-test",
  "prod": "devhub-prod",
  "repo": "devhub-app-web",
  "owner": "bcgov",
  "token": "your oc token" 
}
```
> ENSURE TO NOT ADD YOUR CONFIG FILE AS APART OF THE REPO HISTORY IF YOU ARE INCLUDING THE TOKEN

`oc-clean-stale-artifacts --file=./config.json`

#### Dry runs

Want to see what PRS would have been cleaned without cleaning them?

`oc-clean-stale-artifacts [...your config] --dryrun`

#### Manual PR Cleaning

Want to clean PRS manually? Pass in a `comma-seperated-list` of prs.

`oc-clean-stale-artifacts [...your config] --prs=123,124,125`

---
_Source: https://npm.io/package/openshift-stale-artifact-inspector · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._