1
0
Fork 0
 
 
 
Go to file
snyk-bot ff249fa274 fix: upgrade @azure/storage-blob from 12.23.0 to 12.24.0
Snyk has created this PR to upgrade @azure/storage-blob from 12.23.0 to 12.24.0.

See this package in npm:
@azure/storage-blob

See this project in Snyk:
https://app.snyk.io/org/rizwan-r-r/project/bf58d136-9a15-4e62-b129-f876fe7fc366?utm_source=github&utm_medium=referral&page=upgrade-pr
2024-08-19 07:54:49 +04:00
.github Create node.js.yml 2024-05-18 10:01:56 +04:00
docs Update workflows to use v4 actions (#1652) 2024-02-01 12:50:47 -05:00
packages fix: upgrade @azure/storage-blob from 12.23.0 to 12.24.0 2024-08-19 07:54:49 +04:00
res add logo (#27) 2019-07-10 14:02:56 -04:00
scripts Add disabling explanation in audit-allow-list 2023-01-03 13:33:43 +01:00
.eslintignore add generated to eslintignore 2023-08-07 09:01:14 -07:00
.eslintrc.json Add option for concurrent cache downloads with timeout (#1484) 2023-08-07 13:25:56 -04:00
.gitignore tool-cache: Support for extracting xar compatible archives (#207) 2020-07-15 14:49:23 -04:00
.prettierignore prettier and add generated files to prettierignore 2023-08-07 08:55:42 -07:00
.prettierrc.json Audit Fix (#1480) 2023-08-03 16:36:11 -04:00
CODEOWNERS Update CODEOWNERS (#1673) 2024-02-26 13:31:23 -05:00
CODE_OF_CONDUCT.md updating readmes 2019-10-09 08:47:27 -04:00
LICENSE.md Add License.md to all npm packages (#548) 2020-08-25 16:26:50 -04:00
README.md add new @actions/attest package 2024-02-26 08:52:20 -08:00
SECURITY.md updating readmes 2019-10-09 08:47:27 -04:00
jest.config.js appeasing linter 2024-01-09 19:47:25 +00:00
lerna.json Audit Fix (#1480) 2023-08-03 16:36:11 -04:00
nx.json Audit Fix (#1480) 2023-08-03 16:36:11 -04:00
package-lock.json fixing https://github.com/advisories/GHSA-f5x3-32g6-xq36 2024-04-10 21:30:24 +00:00
package.json . 2024-04-15 15:24:57 +00:00
tsconfig.eslint.json Update eslint to 2.2.7 (#410) 2020-04-13 10:19:49 -04:00
tsconfig.json Update dependencies 2023-09-08 14:29:27 +00:00

README.md

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

✔️ @actions/core

Provides functions for inputs, outputs, results, logging, secrets and variables. Read more here

$ npm install @actions/core

🏃 @actions/exec

Provides functions to exec cli tools and process output. Read more here

$ npm install @actions/exec

🍨 @actions/glob

Provides functions to search for files matching glob patterns. Read more here

$ npm install @actions/glob

☎️ @actions/http-client

A lightweight HTTP client optimized for building actions. Read more here

$ npm install @actions/http-client

✏️ @actions/io

Provides disk i/o functions like cp, mv, rmRF, which etc. Read more here

$ npm install @actions/io

🔨 @actions/tool-cache

Provides functions for downloading and caching tools. e.g. setup-* actions. Read more here

See @actions/cache for caching workflow dependencies.

$ npm install @actions/tool-cache

:octocat: @actions/github

Provides an Octokit client hydrated with the context that the current action is being run in. Read more here

$ npm install @actions/github

💾 @actions/artifact

Provides functions to interact with actions artifacts. Read more here

$ npm install @actions/artifact

🎯 @actions/cache

Provides functions to cache dependencies and build outputs to improve workflow execution time. Read more here

$ npm install @actions/cache

🔏 @actions/attest

Provides functions to write attestations for workflow artifacts. Read more here

$ npm install @actions/attest

Creating an Action with the Toolkit

Choosing an action type

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

Versioning

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

⚠️ Problem Matchers

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

⚠️ Proxy Server Support

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.

...
  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.

async function run() {
  try {
    const ms = core.getInput('milliseconds');
    console.log(`Waiting ${ms} milliseconds ...`)
    ...
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.

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

async function run() {
  try {
    const ms = core.getInput('milliseconds');
    console.log(`Waiting ${ms} milliseconds ...`)
    ...
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.

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.

FROM node:slim
COPY . .
RUN npm install --production
ENTRYPOINT ["node", "/lib/main.js"]
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.

Code of Conduct

See our code of conduct.