feat: Greet GitHub Actor (#1)

Author: shrink

.editorconfig

@@ -0,0 +1,11 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.{js,json,ts,yml}]
+indent_style = space
+indent_size = 2

.github/workflows/package-action.yml

@@ -0,0 +1,24 @@
+name: "Package Action"
+
+on:
+  push:
+    branches:
+      - "release"
+
+jobs:
+  push-changes:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          ssh-key: "${{ secrets.COMMIT_KEY }}"
+      - name: Install Javascript dependencies with npm
+        run: npm install
+      - name: Package action for distribution
+        run: npm run package
+      - name: Push packaged action to branch
+        uses: EndBug/add-and-commit@v7
+        with:
+          add: "dist --force"
+          default_author: github_actions
+          message: "build: Package action as `dist` with latest changes"

.github/workflows/sync-release-branch.yml

@@ -0,0 +1,23 @@
+name: "Synchronise To Release Branch"
+
+on:
+  push:
+    branches:
+      - "main"
+
+env:
+  source: ${{ secrets.BRANCHES_SOURCE || 'main' }}
+  release: ${{ secrets.BRANCHES_RELEASE || 'release' }}
+
+jobs:
+  update-branch:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          ref: "${{ env.release }}"
+          fetch-depth: 0
+          ssh-key: "${{ secrets.COMMIT_KEY }}"
+      - uses: pr-mpt/actions-merge-branch@v1
+        with:
+          from: "origin/${{ env.source }}"

.github/workflows/test.yml

@@ -0,0 +1,51 @@
+name: "Test Action"
+
+on:
+  push:
+    branches:
+      - "**"
+
+jobs:
+  test-unit:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - run: npm install
+      - name: Execute unit tests
+        run: npm run all
+  test-integration:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - run: npm install
+      - run: npm run package
+      - id: default
+        uses: ./
+      - name: Test actor is greeted by default
+        uses: pr-mpt/actions-assert@v2
+        with:
+          assertion: npm://@assertions/is-equal
+          expected: "Hello, ${{ github.actor }}!"
+          actual: "${{ steps.default.outputs.greeting }}"
+      - id: name
+        uses: ./
+        with:
+          name: "Alice T. Ester"
+      - name: Test name is greeted
+        uses: pr-mpt/actions-assert@v2
+        with:
+          assertion: npm://@assertions/is-equal
+          expected: "Hello, Alice T. Ester!"
+          actual: "${{ steps.name.outputs.greeting }}"
+      - id: empty
+        uses: ./
+        with:
+          name: ""
+      - name: Test world is greeted when name is empty
+        uses: pr-mpt/actions-assert@v2
+        with:
+          assertion: npm://@assertions/is-equal
+          expected: "Hello, World!"
+          actual: "${{ steps.empty.outputs.greeting }}"
+
+

.github/workflows/validate-tag.yml

@@ -0,0 +1,22 @@
+name: "Limit Tags To Distributable Commits"
+
+on:
+  push:
+    tags:
+      - "**"
+
+jobs:
+  validate-tag:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          ssh-key: "${{ secrets.COMMIT_KEY }}"
+      - name: Test that the tagged commit includes `dist`
+        uses: pr-mpt/actions-assert@v2
+        with:
+          assertion: npm://@assertions/directory-exists
+          expected: dist
+      - if: failure()
+        name: Delete invalid tag
+        uses: pr-mpt/actions-delete-tag@v1

.gitignore

@@ -0,0 +1,4 @@
+/lib
+/node_modules
+npm-debug.log*
+/dist

LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 > LIMITED and contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

README.md

@@ -0,0 +1,57 @@
+# Example Action
+
+**Example Action** is a companion to
+[Package GitHub Actions automatically with GitHub Actions][blog-post] which
+describes how to automatically package GitHub Actions _using_ GitHub Actions,
+as an alternative GitHub's recommended strategy.
+
+## Project Structure
+
+### Workflows
+
+- [x] [`package-action.yml`](.github/workflows/package-action.yml) **Package Action** using `ncc` to create a single `dist`
+- [x] [`sync-release-branch.yml`](.github/workflows/sync-release-branch.yml) **Synchronise To Release Branch** on push to `main`
+- [x] [`test.yml`](.github/workflows/test.yml) **Test Action** with jest for unit and GitHub Workflow for integration
+- [x] [`validate-tag.yml`](.github/workflows/validate-tag.yml) **Limit Tags To Distributable Commits** by removing tags on commits without `dist`
+
+## How To Demo
+
+* Fork the repository
+* Create a `release` branch from `main`
+* Add a commit key (secret, deploy key)
+
+### Synchronising
+
+* Push changes to `main` and observe `release` is updated with changes
+
+### Packaging
+
+* Push changes to `greeter.ts` on `main` and observe `release` is updated with a new `dist` build
+
+### Tag Validation
+
+* Tag a release on `main` and observe it is removed
+* Tag a release on `release` and observe it is persisted
+
+## Greet With Action
+
+```yaml
+on: [push]
+
+jobs:
+  greet-people:
+    runs-on: ubuntu-latest
+    steps:
+      - id: greeting-actor
+        uses: ./
+      - name: Greet the user that initiated the workflow run
+        run: echo {{ steps.greeting-actor.outputs.greeting }} # Hello, shrink!
+      - id: greeting-person
+        uses: ./
+        with:
+          name: "Alice T. Ester"
+      - name: Greet the person identified by name
+        run: echo {{ steps.greeting-person.outputs.greeting }} # Hello, Alice T. Ester!
+```
+
+[blog-post]: https://medium.com/prompt/a70b9f7bae4

__tests__/greeter.test.ts

@@ -0,0 +1,11 @@
+import { Greeter } from "../src/greeter";
+
+describe("greeter", () => {
+  it("greets user by name", () => {
+    expect(new Greeter("Hello, {name}!").greet("Sam")).toBe("Hello, Sam!");
+  });
+
+  it("greets world when name is empty", () => {
+    expect(new Greeter("Hello, {name}!").greet("")).toBe("Hello, World!");
+  });
+});

action.yml

@@ -0,0 +1,17 @@
+name: "Example Action"
+branding:
+  icon: "loader"
+  color: "white"
+description: "A simple example action that greets someone"
+author: "Samuel Ryan <sam@samryan.co.uk>"
+inputs:
+  name:
+    description: "Name of the person to greet"
+    default: "${{ github.actor }}"
+    required: true
+outputs:
+  greeting:
+    description: "A greeting for the person"
+runs:
+  using: "node12"
+  main: "dist/index.js"