Merge pull request #101 from actions/robherley/✌️

✌️

.github/workflows/ci.yml

@@ -1,13 +1,18 @@
-on:
-  push:
-    branches: ["**"]
+name: CI 🔨
 
+on: 
+  pull_request:
+    branches: ["main"]
+  push:
+    branches: ["main"]
+
+permissions:
+  contents: read
 
 jobs:
   ci:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
     - run: npm install --production
     - run: "./test.sh"
-

.github/workflows/codeql-analysis.yml

@@ -0,0 +1,72 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ "main" ]
+  schedule:
+    - cron: '21 9 * * 1'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'javascript' ]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
+        # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v3
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v2
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+        
+        # Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
+        # queries: security-extended,security-and-quality
+
+        
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v2
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
+
+    #   If the Autobuild fails above, remove it and uncomment the following three lines. 
+    #   modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
+
+    # - run: |
+    #   echo "Run, Build Application using script"
+    #   ./location_of_script_within_repo/buildscript.sh
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v2

.github/workflows/deploy.yml

@@ -0,0 +1,62 @@
+name: Deploy 🚀
+
+on:
+  # Runs on pushes targeting the default branch
+  push:
+    branches: ["main"]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  # Build job
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Pages
+        uses: actions/configure-pages@v5
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version: "20"
+
+      - name: Install dependencies
+        run: npm i --production
+
+      - name: Build Site
+        run: |
+          mkdir ./_site
+          cp favicon.ico ./_site
+          touch ./_site/.nojekyll
+          node action.js html ./_site/index.html
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: "./_site"
+
+  # Deployment job
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -0,0 +1,2 @@
+node_modules
+_site

CODEOWNERS

@@ -0,0 +1 @@
+* @actions/maintainers

Dockerfile

@@ -1,11 +0,0 @@
-FROM node:12
-
-WORKDIR /opt/humans.txt
-
-COPY . /opt/humans.txt
-
-RUN npm i --production
-
-ENV FORCE_COLOR=3
-
-ENTRYPOINT ["bash", "/opt/humans.txt/run.sh"]

README.md

@@ -1,6 +1,12 @@
 # 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.
+
+## Contributing
+
+Add yourself via PR if you work or worked on the product ❤️
+
+To respect each individual's privacy, do not add anyone to this list without asking them first.
 
 ## Inputs
 
@@ -11,5 +17,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>")
+}

actions.yml

@@ -1,11 +0,0 @@
-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'
-    default: 'ascii'
-runs:
-  using: 'docker'
-  image: 'Dockerfile'
-  args:
-    - ${{ inputs.format }}

humans.txt.yaml

@@ -1,4 +1,165 @@
+# 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: "Adrian Mato Gondelle"
+- name: "Ajay Krishna Nalisetty"
+  alum: true
+- name: "Alberto Gimeno"
+  alum: true
+- name: "Allan Guigou"
+- name: "Amarilis Dias"
+  alum: true
+- name: "Andrew Appleton"
+  alum: true
+- name: "Angela Rivera"
+  alum: true
+- name: "Anna Rosenthal"
+  alum: true
+- name: "Anthony Sterling"
+  alum: true
+- name: "Antoine Grondin"
+  alum: true
+- name: "Aris Acoba"
+- name: "Bassem Dghaidi"
+- name: "Belinda Vennam"
+  alum: true
+- name: "Beth Brennan"
+- name: "Bethany Janos"
+  alum: true
+- name: "Brian Cristante"
+  alum: true
+- name: "Brittany Ellich"
+  alum: true
+- name: "Bryan MacFarlane"
+- name: "Cameron Booth"
+  alum: true
+- name: "Catherine Osadciw"
+  alum: true
+- name: "Cedric Wille"
+  alum: true
+- name: "Chad Kimes"
+  alum: true
+- name: "Christina Guo"
+  alum: true
+- name: "Christopher Schleiden"
+  alum: true
+- name: "Cory Miller"
+  alum: true
+- name: "Crystal Tenn"
+  alum: true
+- name: "Dan Rigby"
+  alum: true
+- name: "David Daly"
+  alum: true
+- name: "Dylan Smith"
+  alum: true
+- name: "Edwin Sirko"
+- name: "Erez Testiler"
+  alum: true
+- name: "Eric Sciple"
+- name: "Erika Eggemeyer"
+  alum: true
+- name: "Felipe Suero"
+  alum: true
+- name: "Florian Wagner"
+  alum: true
+- name: "Francesco Renzi"
+  alum: true
+- name: "Guðmundur Bjarni Ólafsson"
+  alum: true
+- name: "Hayden Faulds"
+  alum: true
+- name: "Iheanyi Ekechukwu"
+  alum: true
+- name: "Isaac Shalom"
+  alum: true
+- name: "Jacob Wallraff"
+- name: "Jason Long"
+  alum: true
+- name: "Javier Perez"
+  alum: true
+- name: "Jean-Philippe André"
+  alum: true
+- name: "Jeff Martin"
+- name: "Jeroen Rietveld"
+  alum: true
+- name: "Joanna Krzek-Lubowiecka"
+- name: "Johanan Idicula"
+  alum: true
+- name: "Joel Ambass"
+  alum: true
+- name: "Jonathan Clem"
+  alum: true
+- name: "Jonathan Tamsut"
+  alum: true
+- name: "John Mills"
+  alum: true
+- name: "John Wesley Walker III"
+- name: "Joris Abalea"
+  alum: true
+- name: "Josh Gross"
+  alum: true
+- name: "Julian Dunn"
+  alum: true
+- name: "Julio Barba"
+  alum: true
+- name: "Kamil Grzebien"
+  alum: true
+- name: "Konrad Pabjan"
+  alum: true
+- name: "Laura Yu"
+  alum: true
+- name: "Liela Rotschy"
+  alum: true
+- name: "Maggie Spletzer"
+  alum: true
+- name: "Matt Burke"
+  alum: true
+- name: "Melissa Xie"
+  alum: true
+- name: "Mike Coutermarsh"
+  alum: true
 - name: Mona Lisa Octocat
   honorary_human: true
-
+- name: "Nicholas Bergesen"
+  alum: true
+- name: "Parker Moore"
+  alum: true
+- name: "Patrick Ellis"
+- name: "Patrick Marsceill"
+  alum: true
+- name: "Pete Wagner"
+  alum: true
+- name: "Peter Tasker"
+  alum: true
+- name: "Phani Raj"
+  alum: true
+- name: "Philip Gai"
+- name: "PJ Quirk"
+- name: "Ryan Troost"
+- name: "Rob Herley"
+  alum: true
+- name: "Ross Brodbeck"
+  alum: true
+- name: "Seth Rylan Gainey"
+  alum: true
+- name: "Sneha Kripanandan"
+- name: "Soe Tun"
+  alum: true
+- name: "Sven Pfleiderer"
+  alum: true
+- name: "Thomas Brumley"
+  alum: true
+- name: "Tim Ruffles"
+  alum: true
+- name: "Vallie Joseph"
+  alum: true
+- name: "Yaswanth Anantharaju"
+- name: "Yang Cao"
+- name: "Yena Kim"
+  alum: true
+- name: "Yujin Shin"
+  alum: true
+- name: "Zachary Taylor"

package-lock.json

@@ -1,75 +1,96 @@
 {
+  "name": "humans.txt",
+  "lockfileVersion": 3,
   "requires": true,
-  "lockfileVersion": 1,
-  "dependencies": {
-    "@babel/runtime": {
-      "version": "7.7.7",
-      "resolved": "https://registry.npmjs.org/@babel/runtime/-/runtime-7.7.7.tgz",
-      "integrity": "sha512-uCnC2JEVAu8AKB5do1WRIsvrdJ0flYx/A/9f/6chdacnEZ7LmavjdsDXr5ksYBegxtuTPR5Va9/+13QF/kFkCA==",
-      "requires": {
-        "regenerator-runtime": "^0.13.2"
+  "packages": {
+    "": {
+      "dependencies": {
+        "chalk": "3.0.0",
+        "yaml": "1.7.2"
       }
     },
-    "@types/color-name": {
+    "node_modules/@babel/runtime": {
+      "version": "7.27.3",
+      "resolved": "https://registry.npmjs.org/@babel/runtime/-/runtime-7.27.3.tgz",
+      "integrity": "sha512-7EYtGezsdiDMyY80+65EzwiGmcJqpmcZCojSXaRgdrBaGtWTgDZKq69cPIVped6MkIM78cTQ2GOiEYjwOlG4xw==",
+      "license": "MIT",
+      "engines": {
+        "node": ">=6.9.0"
+      }
+    },
+    "node_modules/@types/color-name": {
       "version": "1.1.1",
       "resolved": "https://registry.npmjs.org/@types/color-name/-/color-name-1.1.1.tgz",
       "integrity": "sha512-rr+OQyAjxze7GgWrSaJwydHStIhHq2lvY3BOC2Mj7KnzI7XK0Uw1TOOdI9lDoajEbSWLiYgoo4f1R51erQfhPQ=="
     },
-    "ansi-styles": {
+    "node_modules/ansi-styles": {
       "version": "4.2.0",
       "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.2.0.tgz",
       "integrity": "sha512-7kFQgnEaMdRtwf6uSfUnVr9gSGC7faurn+J/Mv90/W+iTtN0405/nLdopfMWwchyxhbGYl6TC4Sccn9TUkGAgg==",
-      "requires": {
+      "dependencies": {
         "@types/color-name": "^1.1.1",
         "color-convert": "^2.0.1"
+      },
+      "engines": {
+        "node": ">=8"
       }
     },
-    "chalk": {
+    "node_modules/chalk": {
       "version": "3.0.0",
       "resolved": "https://registry.npmjs.org/chalk/-/chalk-3.0.0.tgz",
       "integrity": "sha512-4D3B6Wf41KOYRFdszmDqMCGq5VV/uMAB273JILmO+3jAlh8X4qDtdtgCR3fxtbLEMzSx22QdhnDcJvu2u1fVwg==",
-      "requires": {
+      "dependencies": {
         "ansi-styles": "^4.1.0",
         "supports-color": "^7.1.0"
+      },
+      "engines": {
+        "node": ">=8"
       }
     },
-    "color-convert": {
+    "node_modules/color-convert": {
       "version": "2.0.1",
       "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz",
       "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==",
-      "requires": {
+      "dependencies": {
         "color-name": "~1.1.4"
+      },
+      "engines": {
+        "node": ">=7.0.0"
       }
     },
-    "color-name": {
+    "node_modules/color-name": {
       "version": "1.1.4",
       "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz",
       "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA=="
     },
-    "has-flag": {
+    "node_modules/has-flag": {
       "version": "4.0.0",
       "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-4.0.0.tgz",
-      "integrity": "sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ=="
+      "integrity": "sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ==",
+      "engines": {
+        "node": ">=8"
+      }
     },
-    "regenerator-runtime": {
-      "version": "0.13.3",
-      "resolved": "https://registry.npmjs.org/regenerator-runtime/-/regenerator-runtime-0.13.3.tgz",
-      "integrity": "sha512-naKIZz2GQ8JWh///G7L3X6LaQUAMp2lvb1rvwwsURe/VXwD6VMfr+/1NuNw3ag8v2kY1aQ/go5SNn79O9JU7yw=="
-    },
-    "supports-color": {
+    "node_modules/supports-color": {
       "version": "7.1.0",
       "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-7.1.0.tgz",
       "integrity": "sha512-oRSIpR8pxT1Wr2FquTNnGet79b3BWljqOuoW/h4oBhxJ/HUbX5nX6JSruTkvXDCFMwDPvsaTTbvMLKZWSy0R5g==",
-      "requires": {
+      "dependencies": {
         "has-flag": "^4.0.0"
+      },
+      "engines": {
+        "node": ">=8"
       }
     },
-    "yaml": {
+    "node_modules/yaml": {
       "version": "1.7.2",
       "resolved": "https://registry.npmjs.org/yaml/-/yaml-1.7.2.tgz",
       "integrity": "sha512-qXROVp90sb83XtAoqE8bP9RwAkTTZbugRUTm5YeFCBfNRPEp2YzTeqWiz7m5OORHzEvrA/qcGS8hp/E+MMROYw==",
-      "requires": {
+      "dependencies": {
         "@babel/runtime": "^7.6.3"
+      },
+      "engines": {
+        "node": ">= 6"
       }
     }
   }

run.sh

@@ -1,3 +0,0 @@
-cd /opt/humans.txt
-
-node 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