{"id":20980492,"url":"https://github.com/hyperjumptech/procheck","last_synced_at":"2025-05-14T15:30:39.800Z","repository":{"id":52657581,"uuid":"317097315","full_name":"hyperjumptech/procheck","owner":"hyperjumptech","description":"A project convention checker (GitHub Actions)","archived":false,"fork":false,"pushed_at":"2021-04-22T02:04:38.000Z","size":220,"stargazers_count":3,"open_issues_count":1,"forks_count":3,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-04-17T13:35:57.931Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/hyperjumptech.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-11-30T03:10:07.000Z","updated_at":"2023-07-27T01:40:45.000Z","dependencies_parsed_at":"2023-01-04T16:50:44.572Z","dependency_job_id":null,"html_url":"https://github.com/hyperjumptech/procheck","commit_stats":{"total_commits":7,"total_committers":4,"mean_commits":1.75,"dds":0.5714285714285714,"last_synced_commit":"c1fff24063c992abfea2642bb348fd34af545795"},"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hyperjumptech%2Fprocheck","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hyperjumptech%2Fprocheck/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hyperjumptech%2Fprocheck/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hyperjumptech%2Fprocheck/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hyperjumptech","download_url":"https://codeload.github.com/hyperjumptech/procheck/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254171541,"owners_count":22026459,"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":[],"created_at":"2024-11-19T05:28:49.425Z","updated_at":"2025-05-14T15:30:38.770Z","avatar_url":"https://github.com/hyperjumptech.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Procheck\n\nA project convention checker\n\n# What it Does\n\nThis action checks for file existence and word existence in a file, using a user-defined configuration. This allows users standardize their many projects using a simple, centralized configurations.\n\n# Example Usage\n\n```\n- name: @hyperjumptech/procheck\n  uses: hyperjumptech/procheck@v1.0.0\n  with:\n    repository: '{YOUR_USERNAME}/{YOUR_REPOSITORY_NAME}'\n    configPath: '{PATH_TO_PROCHECK_JSON}'\n    githubToken: ${{ secrets.GITHUB_TOKEN }}\n```\n\n**NOTE**: You only need Github Token if you're accessing your configurations from private repositories. Set your Github Token here: `https://github.com/settings/tokens`\n\nSet your secrets here: `https://github.com/USERNAME/REPO/settings/secrets`.\n\n# Configuration Example\n\nYou can create a `procheck.json` inside your created repository and use it with this action.\n\n## Available Properties\n\n| Properties | Type     | Required | Description                                         |\n| ---------- | -------- | -------- | --------------------------------------------------- |\n| filePath   | `string` | **true** | Configuration file path                             |\n| contents   | `Array`  | false    | Array of objects of texts that needs to be included |\n\nIn `contents` array object, you only need a `value` key to describe what text should be included in a file.\n\n## Check for file existence\n\nThis example shows you how to check if README.md and package.json is exists.\n\n```\n[\n  {\n    \"filePath\": \"./README.md\",\n  },\n  {\n    \"filePath\": \"./package.json\",\n  }\n]\n```\n\n## Check for file existence with word existence\n\nThis example shows you how to check if README.md is exists and has \"Procheck\" and \"A project convention checker\" text in the file.\n\n```\n[\n  {\n    \"filePath\": \"./README.md\",\n    \"contents\": [\n      {\n        \"value\": \"Procheck\"\n      },\n      {\n        \"value\": \"A project convention checker\"\n      }\n    ]\n  }\n]\n```\n\n# Options\n\n| Options     | Required | Description                                                                                                  |\n| ----------- | -------- | ------------------------------------------------------------------------------------------------------------ |\n| repository  | true     | Your username and your repository name where the configuration resides. e.g `hyperjumptech/procheck-configs` |\n| configPath  | true     | Relative configuration path from repository root e.g `procheck-integration-test/procheck.json`               |\n| githubToken | false    | Github Token to access private repositories                                                                  |\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhyperjumptech%2Fprocheck","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhyperjumptech%2Fprocheck","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhyperjumptech%2Fprocheck/lists"}