Skip to content

Commit

Permalink
Remove readme template
Browse files Browse the repository at this point in the history
  • Loading branch information
csexton committed Oct 2, 2019
1 parent ee50858 commit 5bfdaae
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 109 deletions.
115 changes: 7 additions & 108 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,113 +1,12 @@
# Action Debugger

<p align="center">
<a href="https://github.com/actions/javascript-action"><img alt="GitHub Actions status" src="https://github.com/actions/javascript-action/workflows/test-local/badge.svg"></a>
</p>
Interactive debugger for GitHub Actions

# Create a JavaScript Action
## Acknowledgments

Use this template to bootstrap the creation of a JavaScript action.:rocket:
* [tmate.io](https://tmate.io)
* Max Schmitt's [action-tmate](https://github.com/mxschmitt/action-tmate)

This template includes tests, linting, a validation workflow, publishing, and versioning guidance.
### License

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 Master

Install the dependencies
```bash
$ npm install
```

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 contains 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
const core = require('@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. We will create a releases branch and only checkin production modules (core in this case).

Comment out node_modules in .gitignore and create a releases/v1 branch
```bash
# comment this out distribution branches
# node_modules/
```

```bash
$ git checkout -b releases/v1
$ git commit -a -m "prod dependencies"
```

```bash
$ npm prune --production
$ git add node_modules
$ git commit -a -m "prod dependencies"
$ git push origin releases/v1
```

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 the releases/v1 branch

```yaml
uses: actions/javascript-action@releases/v1
with:
milliseconds: 1000
```
See the [actions tab](https://github.com/actions/javascript-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 tested action
```yaml
uses: actions/javascript-action@v1
with:
milliseconds: 1000
```
The action and associated scripts and documentation in this project are released under the MIT License.
7 changes: 6 additions & 1 deletion script.sh
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,15 @@ tmate -S /tmp/tmate.sock wait tmate-ready
echo To connect to this session copy-n-paste the following into a terminal:
tmate -S /tmp/tmate.sock display -p '#{tmate_ssh}'

echo "echo hi from debugger" >> ~/.bash_profile

# Wait for connection to close or timeout in 15 min
timeout=$((15*60))
while [ -S /tmp/tmate.sock ]; do
sleep 1
timeout=$(($timeout-1))
[ $timeout -gt 0 ] || exit 1
if (( timeout < 0 )); then
echo Waiting on tmate connection timed out!
exit 1
fi
done

0 comments on commit 5bfdaae

Please sign in to comment.