ci: build + docs + publish

.github/FUNDING.yml

@@ -0,0 +1,12 @@
+# These are supported funding model platforms
+
+github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
+patreon: # Replace with a single Patreon username
+open_collective: # Replace with a single Open Collective username
+ko_fi: casraf
+tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
+community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
+liberapay: # Replace with a single Liberapay username
+issuehunt: # Replace with a single IssueHunt username
+otechie: # Replace with a single Otechie username
+custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,47 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: "[BUG] "
+labels: bug, needs-triage
+assignees: chenasraf
+---
+
+#### Describe the bug
+
+A clear and concise description of what the bug is.
+
+#### How To Reproduce
+
+Steps to reproduce the behavior:
+
+1. Prepare templates:
+
+   ```txt
+   This is my {{ template }}
+   ```
+
+2. Run with args/config:
+
+   ```shell
+   npx simple-scaffold@latest -t input -o output TplName
+   ```
+
+#### Expected behavior\*\*
+
+A clear and concise description of what you expected to happen.
+
+#### Logs
+
+If applicable, paste your logs to help explain your problem. To see more logs, run the scaffold with
+`-v 1` to enable debug logging.
+
+#### Desktop (please complete the following information):
+
+- OS: [e.g. macOS, Windows, Linux]
+- OS Version: [e.g. Big Sur, 11, Ubuntu 20.04]
+- Node.js: [e.g. 16.8]
+- Simple Scaffold Version [e.g. 1.1.2]
+
+#### Additional context
+
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,24 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: "[FEATURE] "
+labels: enhancement, needs-triage
+assignees: chenasraf
+---
+
+#### Is your feature request related to a problem? Please describe.
+
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+#### Describe the solution you'd like
+
+A clear and concise description of what you want to happen.
+
+#### Describe alternatives you've considered
+
+A clear and concise description of any alternative solutions or features you've considered, if
+applicable.
+
+#### Additional context
+
+Add any other context or screenshots about the feature request here.

.github/workflows/develop.yml

@@ -0,0 +1,54 @@
+name: Alpha Releases
+
+on:
+  push:
+    branches: [develop, fix/*, feature/*]
+  # pull_request:
+  #   branches: [master, develop]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    if: "!contains(github.event.head_commit.message, '[skip ci]')"
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v1
+        with:
+          node-version: '14.x'
+      - run: yarn install --frozen-lockfile
+      # - run: yarn test
+      - run: yarn build
+      - run: cd ./dist && yarn pack --filename=../package.tgz
+        if: "contains(github.event.head_commit.message, '[publish]')"
+      - uses: Klemensas/action-autotag@stable
+        if: "contains(github.event.head_commit.message, '[publish]')"
+        id: update_tag
+        with:
+          GITHUB_TOKEN: '${{ secrets.GITHUB_TOKEN }}'
+          tag_prefix: 'v'
+      - name: Publish on NPM
+        uses: JS-DevTools/npm-publish@v1
+        if: "contains(github.event.head_commit.message, '[publish]')"
+        with:
+          package: ./dist/package.json
+          token: '${{ secrets.NPM_TOKEN }}'
+      - name: Create Release
+        if: steps.update_tag.outputs.tagname && contains(github.event.head_commit.message, '[publish]')
+        uses: actions/create-release@v1
+        id: create_release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          prerelease: true
+          tag_name: ${{ steps.update_tag.outputs.tagname }}
+          release_name: Release ${{ steps.update_tag.outputs.tagname }}
+      - name: Upload Release Asset
+        if: steps.update_tag.outputs.tagname && contains(github.event.head_commit.message, '[publish]')
+        id: upload-release-asset
+        uses: actions/upload-release-asset@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          upload_url: ${{ steps.create_release.outputs.upload_url }}
+          asset_path: ./package.tgz
+          asset_name: simple-scaffold ${{ steps.update_tag.outputs.tagname }}.tgz
+          asset_content_type: application/tgz

.github/workflows/docs.yml

@@ -0,0 +1,21 @@
+name: Build Documentation
+
+on:
+  push:
+    branches: [master, develop]
+jobs:
+  docs:
+    runs-on: ubuntu-latest
+    if: "!contains(github.event.head_commit.message, '[skip ci]') && !contains(github.event.head_commit.message, '[skip docs]')"
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v1
+        with:
+          node-version: '14.x'
+      - run: cd doc-theme && yarn install && yarn build && rm -rf node_modules && cd ..
+      - run: yarn install --frozen-lockfile
+      - run: yarn docs:build
+      - uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./docs

.github/workflows/pull_requests.yml

@@ -0,0 +1,17 @@
+name: Pull Requests
+
+on:
+  pull_request:
+    branches: [master, develop]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    if: "!contains(github.event.head_commit.message, '[skip ci]')"
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v1
+        with:
+          node-version: '14.x'
+      - run: yarn install --frozen-lockfile
+      - run: yarn build
+      # - run: yarn test

.github/workflows/release.yml

@@ -0,0 +1,50 @@
+name: Release
+
+on:
+  push:
+    branches: [master]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    if: "!contains(github.event.head_commit.message, '[skip ci]')"
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v1
+        with:
+          node-version: '14.x'
+      - run: yarn install --frozen-lockfile
+      # - run: yarn test
+      - run: yarn build
+      - run: cd ./dist && yarn pack --filename=../package.tgz
+        if: "!contains(github.event.head_commit.message, '[skip publish]')"
+      - uses: Klemensas/action-autotag@stable
+        if: "!contains(github.event.head_commit.message, '[skip publish]')"
+        id: update_tag
+        with:
+          GITHUB_TOKEN: '${{ secrets.GITHUB_TOKEN }}'
+          tag_prefix: 'v'
+      - name: Publish on NPM
+        uses: JS-DevTools/npm-publish@v1
+        with:
+          package: ./dist/package.json
+          token: '${{ secrets.NPM_TOKEN }}'
+      - name: Create Release
+        if: steps.update_tag.outputs.tagname && !contains(github.event.head_commit.message, '[skip publish]')
+        uses: actions/create-release@v1
+        id: create_release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          tag_name: ${{ steps.update_tag.outputs.tagname }}
+          release_name: Release ${{ steps.update_tag.outputs.tagname }}
+      - name: Upload Release Asset
+        if: steps.update_tag.outputs.tagname && !contains(github.event.head_commit.message, '[skip publish]')
+        id: upload-release-asset
+        uses: actions/upload-release-asset@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          upload_url: ${{ steps.create_release.outputs.upload_url }}
+          asset_path: ./package.tgz
+          asset_name: simple-scaffold ${{ steps.update_tag.outputs.tagname }}.tgz
+          asset_content_type: application/tgz

.gitignore

@@ -128,3 +128,6 @@ dist
 .yarn/build-state.yml
 .yarn/install-state.gz
 .pnp.*
+
+# Custom
+docs/

package.json

@@ -10,6 +10,7 @@
     "build": "webpack --mode=production --node-env=production",
     "build:dev": "webpack --mode=development",
     "build:prod": "webpack --mode=production --node-env=production",
+    "docs:build": "typedoc --out docs src/index.ts",
     "watch": "webpack --watch"
   },
   "dependencies": {