Update humans.txt.yaml

Add Yujin Shin(@yujincat) in humans.txt

.github/workflows/ci.yml

@@ -1,3 +1,5 @@
+name: CI 🔨
+
 on:
   push:
     branches: ["**"]
@@ -10,4 +12,8 @@ jobs:
     - uses: actions/checkout@v2
     - run: npm install --production
     - run: "./test.sh"
+    - uses: ./
+      name: "Check container builds"
+      with:
+        format: shell
 

.github/workflows/deploy.yml

@@ -0,0 +1,22 @@
+name: Deploy 🚀
+
+on:
+  push:
+    branches: ["main", "deploy-test"]
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - run: mkdir gh-pages
+      - run: cp favicon.ico gh-pages
+      - uses: ./
+        with:
+          format: html
+          output: ./gh-pages/index.html
+      - run: "find ./gh-pages"
+      - uses: peaceiris/[email protected]
+        with:
+          deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
+          publish_dir: gh-pages

README.md

@@ -1,6 +1,6 @@
 # GitHub Actions humans.txt
 
-Lists out the humans who help feed and tend the robots of GitHub Actions.
+[Lists out](https://actions.github.io/humans.txt) the humans who work, or worked, on the GitHub Actions product. Add yourself via PR if you work or worked on the product ❤️
 
 ## Inputs
 
@@ -11,5 +11,8 @@ Options: `txt`, `json`, `shell`
 - txt - a plaintext list of humans
 - json - a list of humans formatted for computers or humans who like their information computery
 - shell - a lovely colourful list of humans making full use of advanced terminal escape-code technology
+- html - a gh-pages friendly html output, which looks like a plaintext humans.txt
 
+## humans.txt
 
+This automatically deploys to https://actions.github.io/humans.txt.

action.js

@@ -6,14 +6,16 @@ const chalk = require('chalk')
 
 const formatters = {
   txt: txtFormatter,
+  html: htmlFormatter,
   json: jsonFormatter,
-  shell: (data) => txtFormatter(data, { colors: true}),
+  shell: (data, opts) => txtFormatter(data, { ...opts, colors: true}),
 }
 
 main()
 
 function main() {
   const format = process.argv[2] || ((process.env.GITHUB_ACTION || process.stdout.isTTY) ? "shell" : "txt")
+  const output = process.argv[3] ? fs.openSync(process.argv[3], "w+") : 1;
 
   const formatter = formatters[format]
   if (!formatter) {
@@ -21,23 +23,25 @@ function main() {
     return
   }
 
-  const data = yaml.parse(fs.readFileSync("./humans.txt.yaml", {encoding: "utf8"}))
+  const data = yaml.parse(fs.readFileSync(__dirname + "/humans.txt.yaml", {encoding: "utf8"}))
 
-  formatter(data)
+  data.humans = data.humans.sort((a,b) => a.name > b.name ? 1 : -1)
+
+  formatter(data, {output})
 }
 
 function invalidFormat(format) {
   const list = Object.keys(formatters).sort().join(",")
   console.error(`'${format}' is not one of the accepted formats ${list}`)
-  process.statusCode = 1
+  process.exitCode = 1
   return
 }
 
-function jsonFormatter({humans}) {
-  console.log(JSON.stringify(humans, null, 4))
+function jsonFormatter({humans}, {output}) {
+  fs.writeSync(output, JSON.stringify(humans, null, 4))
 }
 
-function txtFormatter({humans}, {colors = false} = {}) {
+function txtFormatter({humans}, {colors = false, output} = {}) {
   let active = humans.filter(h => !h.alum).map(h => h.name)
   let alum = humans.filter(h => h.alum).map(h => h.name)
 
@@ -47,17 +51,26 @@ function txtFormatter({humans}, {colors = false} = {}) {
     alum = mapColorRange(alum, active.length, total)
   }
 
-  console.log("Current humans")
-  console.log("==============\n")
-  console.log(active.join("\n"))
-  console.log("\n")
+  fs.writeSync(output, "Current humans\n")
+  fs.writeSync(output,"==============\n\n")
+  fs.writeSync(output,active.join("\n"))
+  fs.writeSync(output,"\n\n")
 
-  console.log("Human alumni")
-  console.log("============\n")
-  console.log(alum.join("\n"))
+  fs.writeSync(output,"Human alumni\n")
+  fs.writeSync(output,"============\n\n")
+  fs.writeSync(output,alum.join("\n"))
 }
 
 function mapColorRange(strings, base, total) {
   return strings.map((n, i) => chalk.hsl(((i + base) / total) * 360, 100, 50)(n))
 }
 
+function htmlFormatter(data, opts) {
+  fs.writeSync(opts.output, `<!doctype html>
+    <meta charset='utf8' />
+    <link rel="icon" type="image/x-icon" href="favicon.ico">
+    <title>Actions - humans.txt</title>
+    <body><pre>`)
+  txtFormatter(data, opts)
+  fs.writeSync(opts.output, "</pre></body>")
+}

action.yml

@@ -2,10 +2,13 @@ name: 'GitHub Actions humans.txt'
 description: 'List out the humans who help feed and tend the robots of GitHub Actions'
 inputs:
   format:
-    description: 'How to output the people of actions - txt, json or ascii'
+    description: 'How to output the people of actions - txt, json, html or ascii'
     default: 'ascii'
+  output:
+    description: 'Where to output the file - stdout otherwise'
 runs:
   using: 'docker'
   image: 'Dockerfile'
   args:
-    - ${{ inputs.format }}
+  - "${{ inputs.format }}"
+  - "${{ inputs.output }}"

humans.txt.yaml

@@ -1,4 +1,49 @@
+# add yourself to this list as a yaml
+# object with the following keys:
+# - name - string - your name
+# - alum - boolean - whether you no longer work on Actions
 humans:
 - name: Mona Lisa Octocat
   honorary_human: true
-
+- name: "Matt Burke"
+  alum: true
+- name: "Angela Rivera"
+  alum: true
+- name: "Pete Wagner"
+  alum: true
+- name: "Parker Moore"
+  alum: true
+- name: "Melissa Xie"
+- name: "Jason Long"
+- name: "Iheanyi Ekechukwu"
+  alum: true
+- name: "Christopher Schleiden"
+- name: "Cameron Booth"
+- name: "Alberto Gimeno"
+- name: "Tim Ruffles"
+  alum: true
+- name: "Andrew Appleton"
+  alum: true
+- name: "Hayden Faulds"
+- name: "Anthony Sterling"
+- name: "Ajay Krishna Nalisetty"
+- name: "Jonathan Clem"
+- name: "Joris Abalea"
+- name: "Jean-Philippe André"
+- name: "Jeroen Rietveld"
+- name: "Mike Coutermarsh"
+- name: "Thomas Brumley"
+- name: "Brian Cristante"
+- name: "Yang Cao"
+- name: "Yujin Shin"
+- name: "Bryan MacFarlane"
+- name: "Josh Gross"
+- name: "Guðmundur Bjarni Ólafsson"
+  alum: true
+- name: "Beth Brennan"
+- name: "PJ Quirk"
+- name: "Chad Kimes"
+- name: "Phani Raj"
+- name: "Konrad Pabjan"
+- name: "Adrian Mato Gondelle"
+- name: "Patrick Marsceill"

run.sh

@@ -1,3 +1 @@
-cd /opt/humans.txt
-
-node action.js $@
+node /opt/humans.txt/action.js $@

test.sh

@@ -7,4 +7,7 @@ node action.js txt
 # check default arg
 node action.js >/dev/null
 node action.js shell
+node action.js html
+node action.js txt /tmp/hu-output
+grep "Current humans" /tmp/hu-output