{"id":28672876,"url":"https://github.com/form8ion/github","last_synced_at":"2026-06-11T08:01:24.485Z","repository":{"id":246771171,"uuid":"822763092","full_name":"form8ion/github","owner":"form8ion","description":"form8ion plugin for projects using GitHub as host for their git repository","archived":false,"fork":false,"pushed_at":"2026-06-02T02:02:25.000Z","size":2885,"stargazers_count":1,"open_issues_count":8,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2026-06-02T04:04:42.678Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/@form8ion/github","language":"JavaScript","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/form8ion.png","metadata":{"files":{"readme":"README.md","changelog":null,"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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2024-07-01T19:13:26.000Z","updated_at":"2026-06-02T02:02:28.000Z","dependencies_parsed_at":"2024-12-16T02:20:08.731Z","dependency_job_id":"22db5ee2-2240-4172-ac15-ac0f73d9820e","html_url":"https://github.com/form8ion/github","commit_stats":null,"previous_names":["form8ion/github"],"tags_count":56,"template":false,"template_full_name":null,"purl":"pkg:github/form8ion/github","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/form8ion%2Fgithub","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/form8ion%2Fgithub/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/form8ion%2Fgithub/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/form8ion%2Fgithub/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/form8ion","download_url":"https://codeload.github.com/form8ion/github/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/form8ion%2Fgithub/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34188272,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-11T02:00:06.485Z","response_time":57,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":"2025-06-13T20:01:12.450Z","updated_at":"2026-06-11T08:01:24.472Z","avatar_url":"https://github.com/form8ion.png","language":"JavaScript","funding_links":[],"categories":["Scaffolding"],"sub_categories":["Official"],"readme":"# github\n\nform8ion plugin for projects using [GitHub](https://github.com) as host for\ntheir git repository\n\n\u003c!--status-badges start --\u003e\n\n[![Node CI Workflow Status][github-actions-ci-badge]][github-actions-ci-link]\n[![Codecov][coverage-badge]][coverage-link]\n![SLSA Level 2][slsa-badge]\n\n\u003c!--status-badges end --\u003e\n\n## Table of Contents\n\n* [Features](#features)\n  * [Creation of GitHub repository](#creation-of-github-repository)\n  * [Configuration of GitHub Repository Settings](#configuration-of-github-repository-settings)\n* [Usage](#usage)\n  * [Installation](#installation)\n  * [Enabling actions against the GitHub API](#enabling-actions-against-the-github-api)\n  * [Enabling repository configuration with `repository-settings/app`](#enabling-repository-configuration-with-repository-settingsapp)\n    * [Account-level settings](#account-level-settings)\n  * [Example](#example)\n    * [Import](#import)\n    * [Execute](#execute)\n* [Contributing](#contributing)\n  * [Dependencies](#dependencies)\n  * [Verification](#verification)\n\n## Features\n\n### Creation of GitHub repository\n\nWhen [authentication is provided](#enabling-actions-against-the-github-api),\na repository will be created on GitHub, assuming one does not already exist.\n\n### Configuration of GitHub Repository Settings\n\nThis plugin configures repository settings by generating the settings file for\nuse by [repository-settings/app](https://github.com/respository-settings/app).\nThe settings in the file will be applied, along with those in the [account-level file](#account-level-settings),\nonce the generated file is pushed to GitHub in the default branch, assuming you\nhave the [repository-settings app installed](#enabling-repository-configuration-with-repository-settingsapp)\nfor your account.\n\n## Usage\n\n\u003c!--consumer-badges start --\u003e\n\n[![MIT license][license-badge]][license-link]\n[![npm][npm-badge]][npm-link]\n[![Try @form8ion/github on RunKit][runkit-badge]][runkit-link]\n![node][node-badge]\n\n\u003c!--consumer-badges end --\u003e\n\n### Installation\n\n```sh\n$ npm install @form8ion/github --save-prod\n```\n\n### Enabling actions against the GitHub API\n\nProvide an authenticated octokit instance as the `octokit` property in the\noptions\n\n### Enabling repository configuration with `repository-settings/app`\n\n* Be sure to [install](https://github.com/apps/settings) for the user or\n  organization account that you are scaffolding the new project for.\n* Enable the settings app for all repositories in the account\n\n#### Account-level settings\n\nThe settings file generated by this tool assumes that it is extending an\n[account level config](https://github.com/probot/probot-config#recipes)\n\n* Ensure that you have created a `.github` repository in your account\n* Create an [account-level settings file](https://github.com/probot/settings#inheritance)\n  in the `.github` repository at the location `.github/settings.yml` within the\n  repository\n  * for an organization account, [this is a good example](https://github.com/form8ion/.github/blob/master/.github/settings.yml)\n  * for a user account, [this is a good example](https://github.com/travi/.github/blob/master/.github/settings.yml)\n\n### Example\n\n#### Import\n\n```javascript\nimport any from '@travi/any';\nimport {Octokit} from '@octokit/core';\nimport {lift, promptConstants, scaffold, test} from '@form8ion/github';\n```\n\n#### Execute\n\n```javascript\nconst projectRoot = process.cwd();\nconst octokitInstance = new Octokit();\nconst logger = {\n  info: message =\u003e console.error(message),\n  success: message =\u003e console.error(message),\n  warn: message =\u003e console.error(message),\n  error: message =\u003e console.error(message)\n};\n\nawait scaffold(\n  {\n    projectRoot,\n    projectName: 'project-name',\n    visibility: any.fromList(['Public', 'Private']),\n    description: any.sentence()\n  },\n  {\n    prompt: async ({id, questions}) =\u003e {\n      const {questionNames, ids} = promptConstants;\n      const {\n        GITHUB_DETAILS: githubDetailsPromptId,\n        ADMIN_SETTINGS: repositorySettingsPromptId\n      } = ids;\n\n      switch (id) {\n        case githubDetailsPromptId: {\n          const {\n            ORGANIZATION: organizationQuestionName,\n            ACCOUNT_TYPE: accountTypeQuestionName\n          } = questionNames[githubDetailsPromptId];\n\n          return {\n            [accountTypeQuestionName]: 'organization',\n            [organizationQuestionName]: questions\n              .find(({name}) =\u003e name === organizationQuestionName)\n              .choices\n              .find(({short}) =\u003e 'organization-name' === short).value\n\n          };\n        }\n        case repositorySettingsPromptId:\n          return {[questionNames[repositorySettingsPromptId].SETTINGS_MANAGED_AS_CODE]: any.boolean()};\n        default:\n          throw new Error(`Unknown prompt with ID: ${id}`);\n      }\n    },\n    octokit: octokitInstance,\n    logger\n  }\n);\n\nif (await test({projectRoot})) {\n  await lift(\n    {\n      projectRoot,\n      vcs: {owner: 'organization-name', name: 'project-name'},\n      results: {\n        projectDetails: {homepage: any.url()},\n        tags: any.listOf(any.word),\n        nextSteps: any.listOf(() =\u003e ({summary: any.sentence(), description: any.sentence()}))\n      }\n    },\n    {\n      octokit: octokitInstance,\n      logger,\n      prompt: async ({id, questions}) =\u003e {\n        const {questionNames, ids} = promptConstants;\n        const expectedPromptId = ids.REQUIRED_CHECK_BYPASS;\n\n        if (expectedPromptId === id) {\n          const {CHECK_BYPASS_TEAM: checkBypassTeamQuestionName} = questionNames[expectedPromptId];\n\n          return {\n            [checkBypassTeamQuestionName]: questions\n              .find(({name}) =\u003e name === checkBypassTeamQuestionName)\n              .choices\n              .find(({short}) =\u003e 'maintainers' === short).value\n          };\n        }\n\n        throw new Error(`Unknown prompt with ID: ${id}`);\n      }\n    }\n  );\n}\n```\n\n## Contributing\n\n\u003c!--contribution-badges start --\u003e\n\n[![Commitizen friendly][commitizen-badge]][commitizen-link]\n[![Conventional Commits][commit-convention-badge]][commit-convention-link]\n[![semantic-release: angular][semantic-release-badge]][semantic-release-link]\n[![Renovate][renovate-badge]][renovate-link]\n[![PRs Welcome][PRs-badge]][PRs-link]\n\n\u003c!--contribution-badges end --\u003e\n\n### Dependencies\n\n```sh\n$ nvm install\n$ npm install\n```\n\n### Verification\n\n```sh\n$ npm test\n```\n\n[commitizen-link]: http://commitizen.github.io/cz-cli/\n\n[commitizen-badge]: https://img.shields.io/badge/commitizen-friendly-brightgreen.svg\n\n[commit-convention-link]: https://conventionalcommits.org\n\n[commit-convention-badge]: https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg\n\n[semantic-release-link]: https://github.com/semantic-release/semantic-release\n\n[semantic-release-badge]: https://img.shields.io/badge/semantic--release-angular-e10079?logo=semantic-release\n\n[renovate-link]: https://renovatebot.com\n\n[renovate-badge]: https://img.shields.io/badge/renovate-enabled-brightgreen.svg?logo=renovate\n\n[PRs-link]: https://makeapullrequest.com\n\n[PRs-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg\n\n[github-actions-ci-link]: https://github.com/form8ion/github/actions?query=workflow%3A%22Node.js+CI%22+branch%3Amaster\n\n[github-actions-ci-badge]: https://img.shields.io/github/actions/workflow/status/form8ion/github/node-ci.yml.svg?branch=master\u0026logo=github\n\n[coverage-link]: https://codecov.io/github/form8ion/github\n\n[coverage-badge]: https://img.shields.io/codecov/c/github/form8ion/github/master?logo=codecov\n\n[slsa-badge]: https://slsa.dev/images/gh-badge-level2.svg\n\n[license-link]: LICENSE\n\n[license-badge]: https://img.shields.io/github/license/form8ion/github.svg?logo=opensourceinitiative\n\n[npm-link]: https://www.npmjs.com/package/@form8ion/github\n\n[npm-badge]: https://img.shields.io/npm/v/@form8ion/github?logo=npm\n\n[runkit-link]: https://npm.runkit.com/@form8ion/github\n\n[runkit-badge]: https://badge.runkitcdn.com/@form8ion/github.svg\n\n[node-badge]: https://img.shields.io/node/v/@form8ion/github?logo=node.js\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fform8ion%2Fgithub","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fform8ion%2Fgithub","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fform8ion%2Fgithub/lists"}