actions
/
toolkit
mirror of https://github.com/actions/toolkit
1
0
Fork 0
Code
97 Commits
164 Branches
18 Tags
27 MiB
TypeScript 98.8%
JavaScript 0.8%
PowerShell 0.3%
 
 
 
Go to file
Danny McCormick 2a2b51f939
Add github package (#32) 
* Add github package

* Docs

* Feedback

* Accidentally added extra

* Allow octokit to be extended

* Respond to feedback

* Feedback
 		2019-07-29 13:09:32 -04:00
.github/workflows Update workflow.yml (#34) 2019-07-25 23:08:57 -04:00
docs Propose github package spec (#31) 2019-07-22 16:26:28 -04:00
packages Add github package (#32) 2019-07-29 13:09:32 -04:00
res add logo (#27) 2019-07-10 14:02:56 -04:00
scripts Simplify package creation 2019-04-22 11:54:05 -04:00
.eslintignore DRY up core tests 2019-05-21 11:23:35 -04:00
.eslintrc.json Add io (#5) 2019-05-22 16:05:34 -04:00
.gitignore Add io (#5) 2019-05-22 16:05:34 -04:00
.prettierignore Add .prettierignore 2019-05-21 10:11:44 -04:00
.prettierrc.json Add ESLint and Prettier tooling 2019-04-19 15:35:44 -04:00
LICENSE.md Add license files 2019-04-20 10:38:10 -04:00
README.md add logo (#27) 2019-07-10 14:02:56 -04:00
jest.config.js Add working Jest & TypeScript config 2019-04-19 15:15:34 -04:00
lerna.json Initialize a Lerna project 2019-04-19 14:29:24 -04:00
package-lock.json Add concurrently and check-all script 2019-05-21 10:43:05 -04:00
package.json v2 workflow (#30) 2019-07-11 16:12:50 -04:00
tsconfig.json Add ESLint 2019-05-21 10:34:23 -04:00

README.md

Packages

Package Description
@actions/core Core functions for setting results, logging, secrets and environment variables
@actions/exec Functions necessary for running tools on the command line
@actions/io Core functions for CLI filesystem scenarios
@actions/tool-cache Functions necessary for downloading and caching tools

Development

This repository uses Lerna to manage multiple packages. Read the documentation there to begin contributing.

Note that before a PR will be accepted, you must ensure:

  • all tests are passing
  • npm run format reports no issues
  • npm run lint reports no issues

Useful Scripts

  • npm run bootstrap This runs lerna bootstrap which will install dependencies in this repository's packages and cross-link packages where necessary.
  • npm run build This compiles TypeScript code in each package (this is especially important if one package relies on changes in another when you're running tests). This is just an alias for lerna run tsc.
  • npm run format This checks that formatting has been applied with Prettier.
  • npm test This runs all Jest tests in all packages in this repository.
    • If you need to run tests for only one package, you can pass normal Jest CLI options: 
      $ npm test -- packages/toolkit
  • npm run create-package [name] This runs a script that automates a couple of parts of creating a new package.

Creating a Package

  1. In a new branch, create a new Lerna package:
$ npm run create-package new-package

This will ask you some questions about the new package. Start with 0.0.0 as the first version (look generally at some of the other packages for how the package.json is structured).

  1. Add tsc script to the new package's package.json file:
"scripts": {
  "tsc": "tsc"
}
  1. Start developing 😄 and open a pull request.