Added a changelog (#18)

* Add changelog and CI/CD

* Updated deploy CI/CD

* Add automatic issue labeler CI/CD

* Add automatic issue closer

* perf: Release of docs 1.0.0

Author: jonerickson

.github/release.yml

@@ -0,0 +1,23 @@
+changelog:
+  exclude:
+    labels:
+      - ignore-for-release
+  categories:
+    - title: Added
+      labels:
+        - 'Type: Enhancement'
+    - title: Changed
+      labels:
+        - 'Type: Maintenance'
+    - title: Deprecated
+      labels:
+        - 'Type: Deprecation'
+    - title: Removed
+      labels:
+        - 'Type: Removed'
+    - title: Fixed
+      labels:
+        - 'Type: Bug'
+    - title: Security
+      labels:
+        - 'Type: Vulnerability'

.github/workflows/changelog.yml

@@ -0,0 +1,54 @@
+name: Update Changelog
+
+on:
+  release:
+    types: [released]
+
+jobs:
+  update-changelog:
+    name: Update Changelog
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - name: Checkout Source Code
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+          ref: ${{ github.event.release.target_commitish }}
+          token: ${{ secrets.CHANGELOG_TOKEN }}
+
+      - name: Extract Release Date
+        id: release_date
+        run: |
+          echo "date=$(git log -1 --date=short --format=%ad '${{ github.event.release.tag_name }}')" >> $GITHUB_OUTPUT;
+
+      - name: Update Changelog
+        uses: stefanzweifel/changelog-updater-action@v1
+        with:
+          release-date: ${{ steps.release_date.outputs.date }}
+          release-notes: ${{ github.event.release.body }}
+          latest-version: ${{ github.event.release.tag_name }}
+
+      - name: Build Commit Message
+        run: |
+          echo "Update CHANGELOG" >> commitmessage.txt
+          echo "[skip ci]" >> commitmessage.txt
+
+      - name: Set Commit Message
+        id: commit_message
+        run: |
+          echo 'commit_message<<EOF' >> $GITHUB_OUTPUT
+          cat commitmessage.txt >> $GITHUB_OUTPUT
+          echo 'EOF' >> $GITHUB_OUTPUT
+
+      - name: Remove Commit Message File
+        run: rm -rf commitmessage.txt
+
+      - name: Commit Updated Changelog
+        uses: stefanzweifel/git-auto-commit-action@v4
+        with:
+          branch: ${{ github.event.release.target_commitish }}
+          commit_message: ${{ steps.commit_message.outputs.commit_message }}
+          file_pattern: CHANGELOG.md
+          push_options: '--force'

.github/workflows/issue.yml

@@ -0,0 +1,24 @@
+name: Label Issues
+
+on:
+  issues:
+    types:
+      - reopened
+      - opened
+
+jobs:
+  label-issues:
+    name: Label Issue
+    runs-on: ubuntu-latest
+    permissions:
+      issues: write
+    steps:
+      - uses: actions/github-script@v6
+        with:
+          script: |
+            github.rest.issues.addLabels({
+              issue_number: context.issue.number,
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              labels: ["Status: In Progress"]
+            })

.github/workflows/main.yaml

@@ -1,14 +1,13 @@
-name: Docs CI/CD
+name: Deploy Documentation
 
 on:
   push:
     branches:
       - master
-      - staging
 
 jobs:
-  build:
-    name: Deploy Docs
+  deploy:
+    name: Deploy Documentation
     runs-on: ubuntu-latest
     timeout-minutes: 10
     steps:
@@ -18,10 +17,11 @@ jobs:
       - name: Setup Node
         uses: actions/setup-node@v3
         with:
-          node-version: 16
+          node-version: 18
+          cache: 'npm'
 
       - name: Install Dependencies
-        run: npm install
+        run: npm ci
 
       - name: Build Application
         run: npm run docs:build
@@ -38,19 +38,16 @@ jobs:
           append_to_pre_release_tag: prerelease
 
       - name: Setup AWS Credentials
-        if: github.ref == 'refs/heads/master'
         uses: aws-actions/configure-aws-credentials@v1
         with:
           aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY }}
           aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
           aws-region: us-east-1
 
       - name: Deploy to S3
-        if: github.ref == 'refs/heads/master'
         run: aws s3 sync ./docs/.vitepress/dist/ s3://${{ secrets.AWS_BUCKET_NAME }} --delete
 
       - name: Invalidate Cloudfront Cache
-        if: github.ref == 'refs/heads/master'
         uses: chetan/invalidate-cloudfront-action@v2
         env:
           DISTRIBUTION: ${{ secrets.AWS_CLOUDFRONT_DISTRIBUTION_ID }}
@@ -60,7 +57,6 @@ jobs:
           AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
 
       - name: Trigger Algolia Crawler Index
-        if: github.ref == 'refs/heads/master'
         uses: algolia/algoliasearch-crawler-github-actions@v1.0.10
         with:
           crawler-user-id: ${{ secrets.CRAWLER_USER_ID }}
@@ -72,8 +68,9 @@ jobs:
 
       - name: Create Release
         uses: ncipollo/release-action@v1
-        if: github.ref == 'refs/heads/master'
         with:
           tag: ${{ steps.tag_version.outputs.new_tag }}
           name: ${{ steps.tag_version.outputs.new_tag }}
-          body: ${{ steps.tag_version.outputs.changelog }}
+          generateReleaseNotes: true
+          makeLatest: true
+          token: ${{ secrets.RELEASE_TOKEN }}

.github/workflows/stale.yml

@@ -0,0 +1,23 @@
+name: Close Inactive Issues/PRs
+
+on:
+  schedule:
+    - cron: "30 1 * * *"
+
+jobs:
+  close-issues:
+    runs-on: ubuntu-latest
+    permissions:
+      issues: write
+      pull-requests: write
+    steps:
+      - uses: actions/stale@v5
+        with:
+          days-before-issue-stale: 30
+          days-before-issue-close: 14
+          stale-issue-label: "stale"
+          stale-issue-message: "This issue is stale because it has been open for 30 days with no activity."
+          close-issue-message: "This issue was closed because it has been inactive for 14 days since being marked as stale."
+          days-before-pr-stale: -1
+          days-before-pr-close: -1
+          repo-token: ${{ secrets.GITHUB_TOKEN }}

CHANGELOG.md

@@ -0,0 +1,9 @@
+# Release Notes
+
+## [Unreleased](https://github.com/DeschutesDesignGroupLLC/PERSCOM-3.0-Docs/compare/v0.0.24...HEAD)
+
+## [v0.0.24](https://github.com/DeschutesDesignGroupLLC/PERSCOM-3.0-Docs/compare/v0.0.23...v0.0.24) - 2023-02-13
+
+### Changed
+
+- Updated docs by @JonErickson in https://github.com/DeschutesDesignGroupLLC/PERSCOM-3.0-Docs/pull/17