Skip to content
This repository has been archived by the owner on Mar 6, 2021. It is now read-only.

Enhancement: Update README.md to reflect migration to yml format #25

Merged
merged 1 commit into from
Aug 14, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,15 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),

## Unreleased

For a full diff see [`0.3.0...master`](https://github.com/localheinz/composer-normalize-action/compare/0.3.0...master).
For a full diff see [`0.3.1...master`](https://github.com/localheinz/composer-normalize-action/compare/0.3.1...master).

## [`0.3.1`](https://github.com/localheinz/composer-normalize-action/releases/tag/0.3.1)

For a full diff see [`0.3.0...0.3.0`](https://github.com/localheinz/composer-normalize-action/compare/0.3.0...0.3.1).

### Changed

* Updated `README.md` to reflect migration to `yml` format ([#25](https://github.com/localheinz/composer-normalize-action/pull/25)), by [@localheinz](https://github.com/localheinz)

## [`0.3.0`](https://github.com/localheinz/composer-normalize-action/releases/tag/0.3.0)

Expand Down
46 changes: 27 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,30 +10,38 @@ That is, when you enable this action, the action will fail when a `composer.json

## Usage

Define a workflow in `.github/main.workflow` like this:
Define a workflow in `.github/workflows/ci.yml` (or add a job if you alread have defined workflows) like this:

```
workflow "Main" {
on = "push"
resolves = ["composer-normalize"]
}

action "composer-normalize" {
uses = "docker://localheinz/composer-normalize-action"
}
```yaml
name: CI

on: push

jobs:
composer-normalize:
name: composer-normalize
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@master
- name: Run localheinz/composer-normalize
uses: docker://localheinz/composer-normalize-action
```

You can also use a specific tag, for example, `x.y.z` (otherwise, `latest` will be used).

```
workflow "Main" {
on = "push"
resolves = ["composer-normalize"]
}

action "composer-normalize" {
uses = "docker://localheinz/composer-normalize-action:x.y.z"
}
```yaml
name: CI

on: push

jobs:
composer-normalize:
name: composer-normalize
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@master
- name: Run localheinz/composer-normalize
uses: docker://localheinz/composer-normalize-action:x.y.z
```

:bulb: Also see [GitHub Actions: Using a Dockerfile image in an action](https://developer.github.com/actions/managing-workflows/workflow-configuration-options/#using-a-dockerfile-image-in-an-action)
Expand Down