Merge pull request #424 from atuttle/feature/release-automation

Release automation

Author: atuttle

.github/release.yml

@@ -3,12 +3,12 @@ changelog:
     labels:
       - release-ignore
   categories:
-    - title: Breaking Changes 🛠
+    - title: Breaking Changes ⚠️
       labels:
         - Semver-Major
     - title: New Features 🎉
       labels:
         - Semver-Minor
-    - title: Other Changes & Fixes
+    - title: Bug Fixes 🐞
       labels:
         - Semver-Patch

.github/workflows/release.yml

@@ -0,0 +1,68 @@
+name: Release New Version
+
+# Based on: https://github.blog/2021-12-16-5-automations-every-developer-should-be-running/
+
+on:
+  workflow_dispatch:
+    inputs:
+      version:
+        description: 'Largest semver bump of new version (major / minor / patch)'
+        required: true
+        type: choice
+        options:
+        - patch
+        - minor
+        - major
+
+jobs:
+  bump-version:
+    runs-on: ubuntu-latest
+
+    steps:
+    # Check out the content (source branch).  Use a deploy key so that
+    # when we push changes, it will trigger the release workflow
+    # run that runs on: tag. (Using the GitHub token would
+    # not run the workflow to prevent infinite recursion.)
+    - name: Check out source
+      uses: actions/checkout@v2
+      with:
+        ssh-key: ${{ secrets.DEPLOY_KEY }}
+
+    - name: Setup Node.js
+      uses: actions/setup-node@v2
+      with:
+        node-version: '16'
+
+    - name: Setup Git
+      run: |
+        git config user.name 'release-bot'
+        git config user.email '[email protected]'
+
+    - name: bump version
+      run: npm version ${{ github.event.inputs.version }}
+
+    - name: Push latest version
+      run: git push origin main --follow-tags
+
+    - name: get-npm-version
+      id: package-version
+      uses: martinbeentjes/npm-get-version-action@master
+
+    - name: Create Release Notes
+      uses: actions/[email protected]
+      with:
+        github-token: ${{secrets.GITHUB_TOKEN}}
+        script: |
+          await github.request(`POST /repos/${{ github.repository }}/releases`, {
+            tag_name: "v${{ steps.package-version.outputs.current-version }}",
+            generate_release_notes: true
+          });
+
+    - name: Cut a docs file for the new release
+      run: |
+        cat docs/@next.md | sed 's/@version@/${{ steps.package-version.outputs.current-version }}/gi' > docs/${{ steps.package-version.outputs.current-version }}.md
+        git add docs/${{ steps.package-version.outputs.current-version }}.md
+        cat docs/readme.md | sed 's/\<\!--new_docs_links_here--\>/\<\!--new_docs_links_here--\>\n\n- \[\v${{ steps.package-version.outputs.current-version }}]\(${{ steps.package-version.outputs.current-version }}.md\)/g' > docs/readme.md
+        git add docs/readme.md
+        git commit -m"New doc file ${{ steps.package-version.outputs.current-version }}.md"
+        git push

CONTRIBUTING.md

@@ -1,4 +1,4 @@
-# Guidelines for Contributing to Taffy
+# Contributing to Taffy
 
 Contributions of all shapes and sizes are welcome, encouraged, and greatly appreciated! Not sure where to start? [Learn how here!](https://makeapullrequest.com)
 
@@ -8,19 +8,22 @@ For all contributions, you'll need a [free GitHub account](https://github.com/jo
 
 Please include all of the following information in your ticket:
 
-- CFML Platform and version (e.g. Adobe ColdFusion 9.0.2, Lucee 4.5.0)
-- Java version (look it up in CF Administrator, or do `java -version` at the command line)
+- CFML Platform and version (e.g. Adobe ColdFusion 9.0.2, or Lucee 4.5.0)
+- Java version (look it up in Lucee/CF Administrator, or do `java -version` at the command line)
 - Taffy version (for bugs)
 
 ## Documentation
 
-Documentation is managed [in its own repository](https://github.com/atuttle/TaffyDocs) and changes are automatically published once they are merged into the `main` branch.
+Documentation is in the `/docs` folder.
 
-There's no such thing as perfect documentation. It can never be thorough enough, never perfectly organized. If you find something confusing or outdated, please be so kind as to file a bug report for it, if you can't or won't fix it. (Yes, documentation bugs!)
+- When fixing a bug for an existing version, if it necessitates a docs update, be sure to update the correct version's markdown file.
+- When adding a new feature, make the appropriate updates to `@next.md`. This file will be used to generate the new version file at release time.
+
+✨ There's no such thing as perfect documentation! It can never be thorough enough, nor ever perfectly organized. If you find something confusing or outdated, please be so kind as to file a bug report for it, if you can't or won't fix it. (Yes, documentation bugs!)
 
 ## Code
 
-Starting with the development of Taffy 1.4, all new development will be done against the `main` branch. When you want to make a change and submit it for the Bleeding Edge Release (BER), do the following:
+All new development is done against the `main` branch. When you want to make a change and submit it for the Bleeding Edge Release (BER), do the following:
 
 1. [Fork the project](https://github.com/atuttle/Taffy/fork_select)
 1. Clone to your local machine: `git clone https://github.com/YOUR-GITHUB-USERNAME/Taffy.git`
@@ -29,7 +32,7 @@ Starting with the development of Taffy 1.4, all new development will be done aga
 1. Push your changes back to your fork. `git push -u origin BRANCH_NAME`
 1. Send a pull request ([Learn how here!](https://makeapullrequest.com))
 
-- Please make sure you select `main` as the destination branch
+- Please make sure you select `atuttle/main` as the destination branch
 
 ### Styling changes
 
@@ -40,6 +43,8 @@ Taffy uses LessCSS to style the dashboard and documentation. To compile changes
 
 ### Tests
 
+_⚠️ Unfortunately our test suite doesn't currently run. We're [working on getting it setup on GitHub Actions](https://github.com/atuttle/Taffy/issues/415) and your help doing so would be greatly appreciated._
+
 If at all possible, please include test cases for anything you add or change. To run the tests, you must have [MxUnit](https://mxunit.org/) installed at `/mxunit` (not just a global mapping, put the folder in your web-root, as there are CSS/JS/etc assets that will be needed).
 
 1. Clone the Taffy repo to `/taffy` in your web root.