Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/actions/toolkit

The GitHub ToolKit for developing GitHub Actions.
https://github.com/actions/toolkit

Last synced: 3 months ago
JSON representation

The GitHub ToolKit for developing GitHub Actions.

Lists

README 

        




  






  Toolkit unit tests status

  Toolkit audit status




## GitHub Actions Toolkit



The GitHub Actions ToolKit provides a set of packages to make creating actions easier.






Get started with the javascript-action template!






## Packages



:heavy_check_mark: [@actions/core](packages/core)



Provides functions for inputs, outputs, results, logging, secrets and variables. Read more [here](packages/core)



```bash

$ npm install @actions/core

```





:runner: [@actions/exec](packages/exec)



Provides functions to exec cli tools and process output. Read more [here](packages/exec)



```bash

$ npm install @actions/exec

```





:ice_cream: [@actions/glob](packages/glob)



Provides functions to search for files matching glob patterns. Read more [here](packages/glob)



```bash

$ npm install @actions/glob

```





:phone: [@actions/http-client](packages/http-client)



A lightweight HTTP client optimized for building actions. Read more [here](packages/http-client)



```bash

$ npm install @actions/http-client

```





:pencil2: [@actions/io](packages/io)



Provides disk i/o functions like cp, mv, rmRF, which etc. Read more [here](packages/io)



```bash

$ npm install @actions/io

```





:hammer: [@actions/tool-cache](packages/tool-cache)



Provides functions for downloading and caching tools.  e.g. setup-* actions. Read more [here](packages/tool-cache)



See @actions/cache for caching workflow dependencies.



```bash

$ npm install @actions/tool-cache

```





:octocat: [@actions/github](packages/github)



Provides an Octokit client hydrated with the context that the current action is being run in. Read more [here](packages/github)



```bash

$ npm install @actions/github

```





:floppy_disk: [@actions/artifact](packages/artifact)



Provides functions to interact with actions artifacts. Read more [here](packages/artifact)



```bash

$ npm install @actions/artifact

```





:dart: [@actions/cache](packages/cache)



Provides functions to cache dependencies and build outputs to improve workflow execution time. Read more [here](packages/cache)



```bash

$ npm install @actions/cache

```





:lock_with_ink_pen: [@actions/attest](packages/attest)



Provides functions to write attestations for workflow artifacts. Read more [here](packages/attest)



```bash

$ npm install @actions/attest

```





## Creating an Action with the Toolkit



:question: [Choosing an action type](docs/action-types.md)



Outlines the differences and why you would want to create a JavaScript or a container based action.








:curly_loop: [Versioning](docs/action-versioning.md)



Actions are downloaded and run from the GitHub graph of repos.  This contains guidance for versioning actions and safe releases.








:warning: [Problem Matchers](docs/problem-matchers.md)



Problem Matchers are a way to scan the output of actions for a specified regex pattern and surface that information prominently in the UI.








:warning: [Proxy Server Support](docs/proxy-support.md)



Self-hosted runners can be configured to run behind proxy servers.








Hello World JavaScript Action



Illustrates how to create a simple hello world javascript action.



```javascript

...

  const nameToGreet = core.getInput('who-to-greet');

  console.log(`Hello ${nameToGreet}!`);

...

```





JavaScript Action Walkthrough



Walkthrough and template for creating a JavaScript Action with tests, linting, workflow, publishing, and versioning.



```javascript

async function run() {

  try {

    const ms = core.getInput('milliseconds');

    console.log(`Waiting ${ms} milliseconds ...`)

    ...

```

```javascript

PASS ./index.test.js

  ✓ throws invalid number

  ✓ wait 500 ms

  ✓ test runs



Test Suites: 1 passed, 1 total

Tests:       3 passed, 3 total

```





TypeScript Action Walkthrough



Walkthrough creating a TypeScript Action with compilation, tests, linting, workflow, publishing, and versioning.



```javascript

import * as core from '@actions/core';



async function run() {

  try {

    const ms = core.getInput('milliseconds');

    console.log(`Waiting ${ms} milliseconds ...`)

    ...

```

```javascript

PASS ./index.test.js

  ✓ throws invalid number

  ✓ wait 500 ms

  ✓ test runs



Test Suites: 1 passed, 1 total

Tests:       3 passed, 3 total

```








Docker Action Walkthrough



Create an action that is delivered as a container and run with docker.



```docker

FROM alpine:3.10

COPY LICENSE README.md /

COPY entrypoint.sh /entrypoint.sh

ENTRYPOINT ["/entrypoint.sh"]

```





Docker Action Walkthrough with Octokit



Create an action that is delivered as a container which uses the toolkit.  This example uses the GitHub context to construct an Octokit client.



```docker

FROM node:slim

COPY . .

RUN npm install --production

ENTRYPOINT ["node", "/lib/main.js"]

```

```javascript

const myInput = core.getInput('myInput');

core.debug(`Hello ${myInput} from inside a container`);



const context = github.context;

console.log(`We can even get context data, like the repo: ${context.repo.repo}`)

```





## Contributing



We welcome contributions.  See [how to contribute](.github/CONTRIBUTING.md).



## Code of Conduct



See [our code of conduct](CODE_OF_CONDUCT.md).