Merge pull request #31 from noclocks/develop

Develop

.github/workflows/changelog.yml

@@ -2,32 +2,37 @@ name: Automate Changelog
 on:
   workflow_dispatch:
   push:
+  pull_request:
     branches:
       - main
 jobs:
   changelog:
-    name: Generate changelog
+    name: Generate Changelog
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
         uses: actions/checkout@v4
         with:
           fetch-depth: 0
           token: ${{ secrets.GITHUB_TOKEN }}
-
-      - name: Generate a changelog
-        uses: orhun/git-cliff-action@v3
+      - name: Run Git Cliff
+        uses: tj-actions/[email protected]
         id: git-cliff
         with:
-          config: ./.github/cliff.toml
-          args: --verbose
-        env:
-          OUTPUT: ./CHANGELOG.md
-
-      - name: Print the changelog
-        run: cat "${{ steps.git-cliff.outputs.changelog }}"
-
-      - name: Commit and Push Changes
-        uses: actions-js/push@master
-        with:
-          github_token: ${{ secrets.GITHUB_TOKEN }}
+          args: "--verbose"
+          output: "CHANGELOG.md"
+          template-config: https://raw.githubusercontent.com/noclocks/.github/main/workflow-templates/cliff.template.toml
+      - name: Print Changelog
+        id: print-changelog
+        run: |
+          cat "CHANGELOG.md"
+      # Commit and push the updated changelog, IF not a pull request
+      - name: Commit and Push Changelog
+        if: github.event_name != 'pull_request'
+        run: |
+          git config user.name 'github-actions[bot]'
+          git config user.email 'github-actions[bot]@users.noreply.github.com'
+          set +e
+          git add CHANGELOG.md
+          git commit -m "[chore]: update changelog"
+          git push https://${{ secrets.GITHUB_TOKEN }}@github.com/${GITHUB_REPOSITORY}.git "main"

docs/about.md

@@ -0,0 +1 @@
+# About

docs/changelog.md

@@ -0,0 +1,70 @@
+# Changelog
+
+> All notable changes to this project will be documented in this file. The format is based on
+[Keep a Changelog](http://keepachangelog.com/) and this project adheres to
+[Semantic Versioning](http://semver.org/).
+
+## [Unreleased]
+
+### Bug Fixes
+
+- Change testimonials to testimonial
+- Fix typescript tripple slash directive
+- Fix typo in dependabot.yml
+- Fix records for mailchimp
+
+### Configuration
+
+- Add vscode spellilng dict
+- Add creds.example.json to config/
+- Fix LF
+- Refactor path to types definition
+- Migrate types to config folder
+
+### Documentation
+
+- Add techstack files
+- Add docs/decisions files
+- Add default docs/ files
+- Add commands to examples
+- Refactor README
+- Add badges to README
+- Add useful commands to README
+- Update README table
+- Update README
+- Update DNS table in README
+- Fix README
+
+### Features
+
+- Add new cname record for testimonials sub-domain
+- Add new TXT records for Stripe and Vercel
+- Add new CNAME records for Stripe
+- Add medium A records
+- Add vercel TXT verification
+- Add custom stripe "pay" subdomain
+- Add amazon verification TXT record
+- Add shopify CNAME record
+- Add google domain verification TXT
+- Add TXT record for github domain verification
+- Add new CNAME records
+- Add `fmt` example output
+- Add various example usage demos
+- Add zone file export
+- Add BIND type to creds
+- Add slack webhook to creds
+- Add TTLs
+- Update DNS records with new email hosting records
+- Add HubSpot blog DNS CNAME record
+- Add changelog and pr mgmt
+
+### Refactoring
+
+- Refactor main dnsconfig
+- Alter dnsconfig
+- Cleanup
+- Refactor dnsconfig
+
+***
+*Changelog generated by [git-cliff](https://github.com/orhun/git-cliff).*
+***

docs/contact.md

@@ -0,0 +1,16 @@
+# Contact
+
+## Email
+
+- [[email protected]](mailto:[email protected])
+
+or individually:
+
+- [Jimmy Briggs](mailto:[email protected])
+- [Patrick Howard](mailto:[email protected])
+
+## Social Media
+
+- [GitHub](https://github.com/noclocks)
+- [LinkedIn](https://www.linkedin.com/company/noclocks)
+- [Twitter](https://twitter.com/noclocksdev)

docs/email-aliases.md

@@ -0,0 +1,120 @@
+# Email Forwarding Aliases
+
+Email forwarding aliases allow you to forward emails sent to one email address to another email address. This is useful if you have multiple email addresses and want to consolidate them into one inbox.
+
+From a business standpoint, email forwarding aliases can be used to create various email addresses for different departments or teams. For example, you could have an email address for sales, support, and billing, and have emails sent to those addresses forwarded to the appropriate team members.
+
+## Creating Email Forwarding Aliases
+
+> **Note:** The process for creating email forwarding aliases will vary depending on your email provider / domain registrar.
+
+Since we use [Porkbub](https://porkbun.com) for our domain registration, we will use their email forwarding service to create email forwarding aliases.
+
+![porkbun-email-forwarding](./assets/img/porkbun-email-forwarding.png)
+
+1. Log in to your Porkbun account.
+2. Navigate to [https://porkbun.com/account/emailhosting/noclocks.dev](https://porkbun.com/account/emailhosting/noclocks.dev).
+3. Add new email forwarding aliases in the "Option 2: Email Forwarding" area on the page.
+4. Save Changes by clicking "Create Email Forward" Button
+
+## Email Forwarding Strategy
+
+At No Clocks, we have configured email forwarding aliases to forward email sent to various aliases to always forward emails to a shared, "root" email address [[email protected]](mailto:[email protected]) which, in turn, forwards the emails to both members of our team.
+
+This allows us to both receive and respond to emails sent to any of the aliases.
+
+Additionally, we have set up some short-hand versions of our full, personal email addresses for convenience. For example, emails sent to [[email protected]](mailto:[email protected]) will be forwarded to [[email protected]](mailto:[email protected]] and emails sent to [[email protected]](mailto:[email protected]) will be forwarded to [[email protected]](mailto:[email protected]).
+
+### Graphical Representation
+
+Here is a graphical representation of our email forwarding strategy flow:
+
+```mermaid
+graph LR
+    subgraph "Email Aliases"
+      admin[[email protected]]
+      contact[[email protected]]
+      dev[[email protected]]
+      feedback[[email protected]]
+      hello[[email protected]]
+      help[help@@noclocks.dev]
+      legal[[email protected]]
+      news[[email protected]]
+      privacy[[email protected]]
+      sales[[email protected]]
+      schedule[[email protected]]
+      store[[email protected]]
+      support[[email protected]]
+      team[[email protected]]
+      test[[email protected]]
+    end
+
+    subgraph ra["Root Alias"]
+      root[[email protected]]
+    end
+
+    subgraph "Team Members"
+
+      jimmybriggs[[email protected]]
+      patrickhoward[[email protected]]
+
+    end
+
+    admin --> root
+    contact --> root
+    dev --> root
+    feedback --> root
+    hello --> root
+    help --> root
+    legal --> root
+    news --> root
+    privacy --> root
+    sales --> root
+    schedule --> root
+    store --> root
+    support --> root
+    team --> root
+    test --> root
+
+    root --> jimmybriggs
+    root --> patrickhoward
+```
+
+As you can see, emails sent to any of the email forwarding aliases will be forwarded to the shared root email address, which will then forward the emails to both team members.
+
+## Current Email Forwarding Aliases
+
+Here are the current email forwarding aliases we have set up for our domain:
+
+|        Forward        |             To              |
+|:---------------------:|:---------------------------:|
+|  [email protected]   |    [email protected]     |
+| [email protected]  |  [email protected]  |
+| [email protected]  | [email protected] |
+|   [email protected]    |    [email protected]     |
+| [email protected] |    [email protected]     |
+|  [email protected]   |    [email protected]     |
+|   [email protected]   |    [email protected]     |
+|  [email protected]   |  [email protected]  |
+|  [email protected]   |    [email protected]     |
+|   [email protected]   |    [email protected]     |
+|   [email protected]    | [email protected] |
+| [email protected]  |    [email protected]     |
+|  [email protected]   |    [email protected]     |
+| [email protected] |    [email protected]     |
+|  [email protected]   |    [email protected]     |
+| [email protected]  |    [email protected]     |
+|   [email protected]   |    [email protected]     |
+|   [email protected]   |    [email protected]     |
+
+And here is a screenshot of the email forwarding aliases we have set up in Porkbun:
+
+![noclocks-email-aliases](./assets/img/noclocks-email-aliases.png)
+
+## Conclusion
+
+Email forwarding aliases are a powerful tool that can help you manage multiple email addresses and consolidate them into one inbox. By setting up email forwarding aliases, you can create different email addresses for different purposes and have all emails sent to those addresses forwarded to a central inbox.
+
+***
+
+[No Clocks, LLC](https://github.com/noclocks) | 2024

docs/index.md

@@ -0,0 +1,25 @@
+# No Clocks Domain Name System (DNS) Records
+
+> This documentation outlines the system in place at [No Clocks, LLC](https://github.com/noclocks) for setting up, maintaining, managing, provisioning, and tracking the various *DNS records* we have set up for our domain: [noclocks.dev](https://noclocks.dev).
+
+## Contents
+
+## Navigation
+
+- [Home](./index.md) (you are here)
+- [Overview](./overview.md)
+- [Tech Stack](./techstack.md)
+
+- [DNS Records](./dns-records.md)
+- [Email Aliases](./email-aliases.md)
+
+- [About](./about.md)
+- [Contact](./contact.md)
+
+- [Changelog](./changelog.md)
+
+## Architecture Decision Records (ADRs)
+
+- [001: Porkbun](./decisions/001-porkbun.md)
+- [002: DNSControl vs. Terraform](./decisions/002-dnscontrol-vs-terraform.md)
+- [003: Docker](./decisions/003-docker.md)

docs/overview.md

@@ -0,0 +1 @@
+# Overview