From 7d29a743f6f3e1c218b7aba7b7bd38585ec5df2b Mon Sep 17 00:00:00 2001 From: Jonathan Clem Date: Fri, 19 Apr 2019 14:53:42 -0400 Subject: [PATCH] Add a placeholder GitHub package This will serve as something to build testing/TypeScript tooling around --- README.md | 11 +++++++++++ __tests__/github.test.js | 9 +++++++++ lib/github.js | 7 +++++++ package.json | 32 ++++++++++++++++++++++++++++++++ 4 files changed, 59 insertions(+) create mode 100644 README.md create mode 100644 __tests__/github.test.js create mode 100644 lib/github.js create mode 100644 package.json diff --git a/README.md b/README.md new file mode 100644 index 0000000..3e607a6 --- /dev/null +++ b/README.md @@ -0,0 +1,11 @@ +# `@actions/github` + +> TODO: description + +## Usage + +``` +const github = require('@actions/github'); + +// TODO: DEMONSTRATE API +``` diff --git a/__tests__/github.test.js b/__tests__/github.test.js new file mode 100644 index 0000000..a585396 --- /dev/null +++ b/__tests__/github.test.js @@ -0,0 +1,9 @@ +'use strict'; + +// const github = require('..'); + +describe('@actions/github', () => { + it('needs tests', () => { + + }); +}); diff --git a/lib/github.js b/lib/github.js new file mode 100644 index 0000000..262b98a --- /dev/null +++ b/lib/github.js @@ -0,0 +1,7 @@ +'use strict'; + +module.exports = github; + +function github() { + // TODO +} diff --git a/package.json b/package.json new file mode 100644 index 0000000..c2dd0c9 --- /dev/null +++ b/package.json @@ -0,0 +1,32 @@ +{ + "name": "@actions/github", + "version": "0.0.0", + "description": "Actions tools for the GitHub API and GitHub context", + "keywords": [ + "github", + "actions", + "toolkit" + ], + "homepage": "https://github.com/actions/toolkit/tree/master/packages/github", + "license": "MIT", + "directories": { + "lib": "lib", + "test": "__tests__" + }, + "files": [ + "lib" + ], + "publishConfig": { + "access": "public" + }, + "repository": { + "type": "git", + "url": "git+https://github.com/actions/toolkit.git" + }, + "scripts": { + "test": "echo \"Error: run tests from root\" && exit 1" + }, + "bugs": { + "url": "https://github.com/actions/toolkit/issues" + } +}