{"id":16947761,"url":"https://github.com/kanata2/esa-freshness-patroller","last_synced_at":"2025-04-11T20:05:56.824Z","repository":{"id":59045355,"uuid":"492633659","full_name":"kanata2/esa-freshness-patroller","owner":"kanata2","description":"patrol documentations at esa.io","archived":false,"fork":false,"pushed_at":"2023-04-17T14:45:11.000Z","size":90,"stargazers_count":4,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-11T20:05:46.020Z","etag":null,"topics":["documentation","esa-io","golang"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kanata2.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-05-16T00:07:41.000Z","updated_at":"2024-05-21T07:35:45.000Z","dependencies_parsed_at":"2024-06-20T09:24:44.207Z","dependency_job_id":"05d58518-2f8c-4ff2-8eff-940c08c7bcc4","html_url":"https://github.com/kanata2/esa-freshness-patroller","commit_stats":null,"previous_names":[],"tags_count":23,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kanata2%2Fesa-freshness-patroller","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kanata2%2Fesa-freshness-patroller/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kanata2%2Fesa-freshness-patroller/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kanata2%2Fesa-freshness-patroller/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kanata2","download_url":"https://codeload.github.com/kanata2/esa-freshness-patroller/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248473127,"owners_count":21109628,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["documentation","esa-io","golang"],"created_at":"2024-10-13T21:48:16.568Z","updated_at":"2025-04-11T20:05:56.788Z","avatar_url":"https://github.com/kanata2.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"esa-freshness-patroller :cop:\n===\n\nThis is a PoC to maintain the documentation's freshness in esa.io.  \nThis is inspired by Google's efforts as described in \"Software Engineering at Google\".\n\n## How to use\n\n1. Adding one of the following annotations\n2. Run `esa-freshness-patroller`\n\n### Annotations\nYou can use one of the following annotations for including targets of patroller.\nAnnotations should basicallythe be added at the beginning of the document.\n\n#### (Recommend) 1. fenced code style\nAdding a fenced code which has `esa-freshness-patroller` info string to each post.\nThis must be written in YAML according to the following schema.\n\n| Key | Required | Type | Description |\n| --- | -------- | ---- | ----------- |\n| `owners` | Yes | Array of string | documentation owner/reviewer |\n| `last_checked_at` | Yes | String(format: `YYYY/MM/DD`) | last reviewed date by owner/reviewers |\n| `check_interval_days` | No | Number | day for patrolling interval. this takes precedence over oeverall configuration |\n| `skip` | No | Bool | excluding from patrolling targets |\n| `custom` | No | Mapping(key/value is String) | custom metadata that can be added freely |\n\n\nExample:\n\n````markdown\n```esa-freshness-patroller\nowners: [kanata2, kanata1]\nlast_checked_at: 2022/12/11\ninterval: 30\nskip: false\ncustom:\n  category: daily\n  team: SRE\n```\n````\n\n#### (Opt-in) 2. Simple text style\nAdding `Last checked at YYYY/MM/DD by @username,@username2,...` in your documents.\nIf you want to set `check_interval_days`, `skip` etc, you should use **fenced code style**.\nThis is disabled by default and should be enabled as needed.\n\n\n### General configurations\nYou can set general configurations through CLI arguments, environment variables or config file.\n\n| Name | Required | Type | Environment variable | CLI argument | key for Config file(YAML) |\n| ---- | -------- | ---- | -------------------- | ------------ | ----------------- |\n| esa.io's API Key | Yes | String | `ESA_API_KEY` | | esaApiKey (not recommended) |\n| esa team | Yes | String | `TEAM` | `--team` | team | \n| esa's search query | Yes | String | `QUERY` | `--query` | query |\n| config file | No(default: ./config.yaml) | String | `CONFIG` | `--config` | |\n| debug mode | No | Bool | `DEBUG` | | debug |\n| output type | No(default: 'json') | String(json or go-template) | `OUTPUT_TYPE` | `--output` | outputType |\n| Go template file path | No(Yes if output type is go-template) | String | `TEMPLATE` | `--template` | template |\n| destination type | No(default: 'stdout') | String(stdout or esa) | `DESTINATION` | `--destination` | destination |\n| esa's post number for reporting results | No(Yes if destination type is esa) | Number | | | esa.reportPostNumber |\n| outdated threshold | No | Number | `OUTDATED_THRESHOLD` | `--outdated-threshold` | outdatedThreshold |\n| enable simple text format for annotation | No | Bool | `WITH_SIMPLE_FORMAT` | `--with-simple-format` | withSimpleFormat |\n\nPriority: CLI arguments \u003e Environment variables \u003e Config file\n\n## How to use esa-freshness-patroller as Go module\n\n```\n$ go get github.com/kanata2/esa-freshness-patroller/patroller\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkanata2%2Fesa-freshness-patroller","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkanata2%2Fesa-freshness-patroller","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkanata2%2Fesa-freshness-patroller/lists"}