Skip to content

Commit

Permalink
v1 release
Browse files Browse the repository at this point in the history
  • Loading branch information
nblfikr committed Jan 30, 2023
1 parent 96ea2e8 commit 5846c07
Show file tree
Hide file tree
Showing 17 changed files with 4,953 additions and 273 deletions.
9 changes: 6 additions & 3 deletions .github/workflows/check-dist.yml
Original file line number Diff line number Diff line change
Expand Up @@ -28,13 +28,16 @@ jobs:
with:
node-version: 16.x

- name: Install pnpm
run: npm i -g pnpm

- name: Install dependencies
run: npm ci
run: pnpm install --frozen-lockfile

- name: Rebuild the dist/ directory
run: |
npm run build
npm run package
pnpm run build
pnpm run package
- name: Compare the expected and actual dist/ directories
run: |
Expand Down
8 changes: 5 additions & 3 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,16 @@ jobs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- run: npm i -g pnpm
- run: |
npm install
pnpm install
- run: |
npm run all
pnpm run all
test: # make sure the action works on a clean machine without building
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: ./
with:
milliseconds: 1000
filename: example
base64: ${{ secrets.BASE64_STRING}}
107 changes: 9 additions & 98 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,105 +1,16 @@
<p align="center">
<a href="https://github.com/actions/typescript-action/actions"><img alt="typescript-action status" src="https://github.com/actions/typescript-action/workflows/build-test/badge.svg"></a>
<a href="https://github.com/actions/typescript-action/actions"><img alt="typescript-action status" src="https://github.com/nblfikr/base64-decode-to-file/workflows/build-test/badge.svg"></a>
</p>

# Create a JavaScript Action using TypeScript
# Base64 String Decode To File

Use this template to bootstrap the creation of a TypeScript action.:rocket:
This action will help you decode a base64 string to a file.

This template includes compilation support, tests, a validation workflow, publishing, and versioning guidance.
## Usage

If you are new, there's also a simpler introduction. See the [Hello World JavaScript Action](https://github.com/actions/hello-world-javascript-action)

## Create an action from this template

Click the `Use this Template` and provide the new repo details for your action

## Code in Main

> First, you'll need to have a reasonably modern version of `node` handy. This won't work with versions older than 9, for instance.
Install the dependencies
```bash
$ npm install
```

Build the typescript and package it for distribution
```bash
$ npm run build && npm run package
```

Run the tests :heavy_check_mark:
```bash
$ npm test

PASS ./index.test.js
✓ throws invalid number (3ms)
wait 500 ms (504ms)
test runs (95ms)

...
```

## Change action.yml

The action.yml defines the inputs and output for your action.

Update the action.yml with your name, description, inputs and outputs for your action.

See the [documentation](https://help.github.com/en/articles/metadata-syntax-for-github-actions)

## Change the Code

Most toolkit and CI/CD operations involve async operations so the action is run in an async function.

```javascript
import * as core from '@actions/core';
...

async function run() {
try {
...
}
catch (error) {
core.setFailed(error.message);
}
}

run()
```

See the [toolkit documentation](https://github.com/actions/toolkit/blob/master/README.md#packages) for the various packages.

## Publish to a distribution branch

Actions are run from GitHub repos so we will checkin the packed dist folder.

Then run [ncc](https://github.com/zeit/ncc) and push the results:
```bash
$ npm run package
$ git add dist
$ git commit -a -m "prod dependencies"
$ git push origin releases/v1
```

Note: We recommend using the `--license` option for ncc, which will create a license file for all of the production node modules used in your project.

Your action is now published! :rocket:

See the [versioning documentation](https://github.com/actions/toolkit/blob/master/docs/action-versioning.md)

## Validate

You can now validate the action by referencing `./` in a workflow in your repo (see [test.yml](.github/workflows/test.yml))

```yaml
uses: ./
with:
milliseconds: 1000
```
See the [actions tab](https://github.com/actions/typescript-action/actions) for runs of this action! :rocket:
## Usage:
After testing you can [create a v1 tag](https://github.com/actions/toolkit/blob/master/docs/action-versioning.md) to reference the stable and latest V1 action
- uses: nblfikr/base64-decode-to-file@v1
with:
filename: example.txt
base64: aGVsbG8K
```
29 changes: 0 additions & 29 deletions __tests__/main.test.ts

This file was deleted.

28 changes: 28 additions & 0 deletions __tests__/utils.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
import * as fs from 'fs'
import {dirname} from 'path'
import {describe, test, expect, beforeAll} from '@jest/globals'
import {decode, writeFile} from '../src/utils'

const pathfile = `${dirname(__dirname)}/example`

let base64String: string
let binary: Buffer
let fullpath: string

beforeAll(() => {
base64String = fs.readFileSync(pathfile, {encoding: 'base64'})
binary = fs.readFileSync(pathfile)
fullpath = writeFile(binary, 'example')
})

describe('decode method', () => {
test('it should decode base64 string to binary', () => {
expect(decode(base64String)).toEqual(binary)
})
})

describe('writeFile method', () => {
test('it should write the file into path', () => {
expect(fs.existsSync(fullpath)).toEqual(true)
})
})
18 changes: 13 additions & 5 deletions action.yml
Original file line number Diff line number Diff line change
@@ -1,11 +1,19 @@
name: 'Your name here'
description: 'Provide a description here'
author: 'Your name or organization here'
name: 'base64-decode-to-file'
description: 'This action will help you decode a base64 string to a file'
author: 'nblfikr'
inputs:
milliseconds: # change this
filename:
required: true
description: 'specify the filename'
base64:
required: true
description: 'input description here'
default: 'default value if applicable'
outputs:
fullpath:
description: 'The result of this action'
runs:
using: 'node16'
main: 'dist/index.js'
branding:
icon: 'unlock'
color: 'green'
Loading

0 comments on commit 5846c07

Please sign in to comment.