Merge pull request #11 from algorandfoundation/feat/convential-commits

ci: conventional commits

.github/workflows/CI.yml

@@ -1,5 +1,7 @@
 name: CI
-on: [pull_request]
+on:
+  pull_request:
+    branches: [main, develop]
 jobs:
   build:
     runs-on: ubuntu-latest

.github/workflows/release.yml

@@ -0,0 +1,49 @@
+name: Release
+on:
+  push:
+    branches: ['main', 'release/*']
+jobs:
+  npm-publish:
+    runs-on: ubuntu-latest
+    permissions:
+      issues: write
+      contents: write
+      packages: write
+      pull-requests: write
+      id-token: write
+    steps:
+      - uses: actions/create-github-app-token@v1
+        id: app-token
+        with:
+          app-id: ${{ secrets.BOT_ID }}
+          private-key: ${{ secrets.BOT_SK }}
+      - uses: actions/checkout@v3
+        with:
+          token: ${{ steps.app-token.outputs.token }}
+      - uses: actions/setup-node@v4
+        with:
+          node-version: '20.x'
+          cache: 'npm'
+      - run: npm install
+      - run: npm run release
+        env:
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+          GITHUB_TOKEN: ${{ steps.app-token.outputs.token }}
+      - name: Merge Release -> Trunk
+        uses: devmasx/merge-branch@854d3ac71ed1e9deb668e0074781b81fdd6e771f
+        if: github.ref == 'refs/heads/release/1.x'
+        with:
+          type: now
+          from_branch: release/1.x
+          target_branch: main
+          github_token: ${{ steps.app-token.outputs.token }}
+      - name: Build documentation
+        run: npm run typedoc
+      - name: Publish to Cloudflare Pages
+        id: deploy
+        uses: cloudflare/wrangler-action@v3
+        with:
+          apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
+          accountId: ${{ secrets.CF_ACCOUNT_ID }}
+          command: |
+            pages deploy docs --project-name ${{ secrets.CF_PROJECT_NAME }}

.gitignore

@@ -1,3 +1,5 @@
+docs
+.idea
 dist/*
 !dist/esm
 dist/esm/*
@@ -105,9 +107,8 @@ out
 # vuepress build output
 .vuepress/dist
 
-# vuepress v2.x temp and cache directory
+# vuepress v2.x temp
 .temp
-.cache
 
 # Docusaurus cache and generated files
 .docusaurus

CONTRIBUTING.md

@@ -0,0 +1,40 @@
+
+
+## Release Workfow
+
+```mermaid
+---
+title: Git Flow
+---
+
+gitGraph
+   commit tag: "0.37.0"
+   branch dev
+   checkout dev
+   branch "feat/add-foo-123"
+   checkout "feat/add-foo-123"
+   commit id: "feat(foo): ..."
+   commit id: "doc(foo): ..."
+    checkout dev
+    branch "feat/add-bar-123"
+   checkout dev
+   branch "feat/add-baz-123"
+    checkout dev
+    merge "feat/add-foo-123" tag: "v1.0.0.beta.1"
+    checkout feat/add-bar-123
+   commit id: "chore(baz): ..."
+   commit id: "feat(baz): ..."
+   checkout dev
+   merge feat/add-bar-123 tag: "v1.0.0.beta.2"
+   checkout main
+   merge dev type: HIGHLIGHT tag: "v1.0.0"
+   checkout dev
+   merge main tag: "v1.0.0"
+   checkout "feat/add-baz-123"
+   commit id: "doc(bar): ..."
+   checkout dev
+   merge "feat/add-baz-123" tag: "v1.1.0-beta.1"
+   checkout main
+   merge dev type: HIGHLIGHT tag: "v1.1.0"
+   
+```