Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
frankie567 committed Feb 18, 2020
1 parent a1c244e commit fc347d5
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 105 deletions.
125 changes: 22 additions & 103 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,114 +1,33 @@
# Google Cloud Datastore Action

<p align="center">
<a href="https://github.com/actions/javascript-action/actions"><img alt="javscript-action status" src="https://github.com/actions/javascript-action/workflows/units-test/badge.svg"></a>
<a href="https://github.com/BeeMyDesk/cloud-datastore-action/actions"><img alt="status" src="https://github.com/BeeMyDesk/cloud-datastore-action/workflows/units-test/badge.svg"></a>
</p>

# Create a JavaScript Action
Easily set an entity in Google Cloud Datastore during your GitHub Actions workflow.

Use this template to bootstrap the creation of a JavaScript action.:rocket:

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

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.

## Package for distribution

GitHub Actions will run the entry point from the action.yml. Packaging assembles the code into one file that can be checked in to Git, enabling fast and reliable execution and preventing the need to check in node_modules.

Actions are run from GitHub repos. Packaging the action will create a packaged action in the dist folder.

Run package

```bash
npm run package
```

Since the packaged index.js is run from the dist folder.

```bash
git add dist
```

## Create a release branch

Users shouldn't consume the action from master since that would be latest code and actions can break compatibility between major versions.

Checkin to the v1 release branch

```bash
$ git checkout -b v1
$ git commit -a -m "v1 release"
```
## Usage

```bash
$ git push origin v1
```yaml
- uses: BeeMyDesk/cloud-datastore-action@v1
with:
credentials: ${{ secrets.GOOGLE_APPLICATION_CREDENTIALS }}
project_id: ${{ secrets.GOOGLE_PROJECT_ID }}
action: save
entity_kind: cloud-datastore-action-test
entity_name: cloud-datastore-action-test-${{ matrix.action }}
entity_data: '{"value": 42, "sha": "${{github.sha}}"}'
```
Your action is now published! :rocket:
### Parameters
See the [versioning documentation](https://github.com/actions/toolkit/blob/master/docs/action-versioning.md)
* `credentials`: [Service account key for GCP](https://console.cloud.google.com/apis/credentials/serviceaccountkey), **exported as JSON** and **encoded in base64**. To encode a JSON file, you can do: `base64 ~/credentials.json`.
* `project_id`: Google Cloud Project ID.
* `action`: Action to perform on the entity. `save` will overwrite the whole entity, while `merge` will keep the existing properties not specified here.
* `entity_kind`: Kind of entity.
* `entity_name`: Name of the entity to insert/update.
* `entity_data`: JSON representation of the entity data.

## Usage

You can now consume the action by referencing the v1 branch

```yaml
uses: actions/javascript-action@v1
with:
milliseconds: 1000
```
## License

See the [actions tab](https://github.com/actions/javascript-action/actions) for runs of this action! :rocket:
[MIT License](https://github.com/BeeMyDesk/cloud-datastore-action/blob/master/LICENSE)
4 changes: 2 additions & 2 deletions action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,10 @@ inputs:
description: 'Service account key encoded in base64.'
required: true
project_id:
description: 'Google Cloud project ID'
description: 'Google Cloud Project ID'
required: true
action:
description: 'Action to perform on the entity. "save" will overwrite the whole entity, while "merge" will keep the existing value that are not specified.'
description: 'Action to perform on the entity. `save` will overwrite the whole entity, while `merge` will keep the existing properties not specified here.'
required: true
default: save
entity_kind:
Expand Down

0 comments on commit fc347d5

Please sign in to comment.