-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: adding netlify and vercel configuration as an optional step; ad…
…ding algokit media guide compliant image asset (#4) * feat: expanding copier template with continuous deployment provider setup * docs: adding readme header assets * docs: refining readme * refactor: refining copier flow * chore: regenerating templates * chore: regenerating templates * feat: refining the approach; using workflows instead; adding missing env vars * refactor: addressing pr comments * refactor: addressing pr comments * refactor: addressing pr comments
- Loading branch information
1 parent
9012e3f
commit 135112a
Showing
99 changed files
with
9,596 additions
and
255 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,86 +1,96 @@ | ||
| _subdirectory: template_content | ||
|
|
||
| # questions | ||
| # project_name should never get prompted, AlgoKit should always pass it by convention | ||
| project_name: | ||
| type: str | ||
| help: Name for this project. | ||
| placeholder: "algorand-app" | ||
|
|
||
| author_name: | ||
| type: str | ||
| help: Package author name | ||
| placeholder: "Your Name" | ||
|
|
||
| author_email: | ||
| type: str | ||
| help: Package author email | ||
| placeholder: "[email protected]" | ||
|
|
||
| ide_vscode: | ||
| type: bool | ||
| help: Do you want to add VSCode configuration? | ||
| default: yes | ||
|
|
||
| use_eslint_prettier: | ||
| type: bool | ||
| help: Do you want to use ESLint and Prettier for code linting and formatting? | ||
| default: yes | ||
|
|
||
| use_tailwind: | ||
| type: bool | ||
| help: Do you want to use Tailwind CSS? A utility-first CSS framework for rapidly building custom designs. | ||
| default: yes | ||
|
|
||
| use_daisy_ui: | ||
| type: bool | ||
| help: Do you want to use a daisyUI? Framework agnostic CSS component library for building modern websites and web applications fast. | ||
| default: yes | ||
| when: "{{ use_tailwind != false }}" | ||
|
|
||
| use_jest: | ||
| type: bool | ||
| help: Do you want to include unit tests (via Jest)? | ||
| default: yes | ||
|
|
||
| use_playwright: | ||
| type: bool | ||
| help: Do you want to include end to end tests (via Playwright)? | ||
| default: yes | ||
|
|
||
| use_github_actions: | ||
| type: bool | ||
| help: Do you want to include Github Actions workflows for build validation? | ||
| default: yes | ||
|
|
||
| # The following should never get prompted; algokit should always pass these values through by convention | ||
|
|
||
| algod_token: | ||
| type: str | ||
| help: Default Algod Token | ||
| default: "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" | ||
|
|
||
| algod_server: | ||
| type: str | ||
| help: Default Algod server | ||
| default: "http://localhost" | ||
|
|
||
| algod_port: | ||
| type: int | ||
| help: Default Algod port | ||
| default: 4001 | ||
|
|
||
| indexer_token: | ||
| type: str | ||
| help: Default Indexer token | ||
| default: "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" | ||
|
|
||
| indexer_server: | ||
| type: str | ||
| help: Default Indexer server | ||
| default: "http://localhost" | ||
|
|
||
| indexer_port: | ||
| type: int | ||
| help: Default Indexer port | ||
| default: 8980 | ||
| _subdirectory: template_content | ||
|
|
||
| # questions | ||
| # project_name should never get prompted, AlgoKit should always pass it by convention | ||
| project_name: | ||
| type: str | ||
| help: Name for this project. | ||
| placeholder: "algorand-app" | ||
|
|
||
| author_name: | ||
| type: str | ||
| help: Package author name | ||
| placeholder: "Your Name" | ||
|
|
||
| author_email: | ||
| type: str | ||
| help: Package author email | ||
| placeholder: "[email protected]" | ||
|
|
||
| ide_vscode: | ||
| type: bool | ||
| help: Do you want to add VSCode configuration? | ||
| default: yes | ||
|
|
||
| use_eslint_prettier: | ||
| type: bool | ||
| help: Do you want to use ESLint and Prettier for code linting and formatting? | ||
| default: yes | ||
|
|
||
| use_tailwind: | ||
| type: bool | ||
| help: Do you want to use Tailwind CSS? A utility-first CSS framework for rapidly building custom designs. | ||
| default: yes | ||
|
|
||
| use_daisy_ui: | ||
| type: bool | ||
| help: Do you want to use a daisyUI? Framework agnostic CSS component library for building modern websites and web applications fast. | ||
| default: yes | ||
| when: "{{ use_tailwind != false }}" | ||
|
|
||
| use_jest: | ||
| type: bool | ||
| help: Do you want to include unit tests (via Jest)? | ||
| default: yes | ||
|
|
||
| use_playwright: | ||
| type: bool | ||
| help: Do you want to include end to end tests (via Playwright)? | ||
| default: yes | ||
|
|
||
| use_github_actions: | ||
| type: bool | ||
| help: Do you want to include Github Actions workflows for build validation? | ||
| default: yes | ||
|
|
||
| cloud_provider: | ||
| type: str | ||
| help: Pick your website hosting provider for continuous delivery | ||
| when: "{{ use_github_actions != false }}" | ||
| choices: | ||
| Netlify: "netlify" | ||
| Vercel: "vercel" | ||
| Skip CD setup: "none" | ||
| default: "netlify" | ||
|
|
||
| # The following should never get prompted; algokit should always pass these values through by convention | ||
|
|
||
| algod_token: | ||
| type: str | ||
| help: Default Algod Token | ||
| default: "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" | ||
|
|
||
| algod_server: | ||
| type: str | ||
| help: Default Algod server | ||
| default: "http://localhost" | ||
|
|
||
| algod_port: | ||
| type: int | ||
| help: Default Algod port | ||
| default: 4001 | ||
|
|
||
| indexer_token: | ||
| type: str | ||
| help: Default Indexer token | ||
| default: "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" | ||
|
|
||
| indexer_server: | ||
| type: str | ||
| help: Default Indexer server | ||
| default: "http://localhost" | ||
|
|
||
| indexer_port: | ||
| type: int | ||
| help: Default Indexer port | ||
| default: 8980 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2,8 +2,6 @@ name: Pull Request validation | |
|
|
||
| on: [pull_request] | ||
|
|
||
|
|
||
|
|
||
| jobs: | ||
| pr-check: | ||
| name: Perform Checks | ||
|
|
||
77 changes: 77 additions & 0 deletions
77
....github{% endif %}/workflows/{% if cloud_provider != none %}release.yaml{% endif %}.jinja
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,77 @@ | ||
| name: Release | ||
|
|
||
| on: | ||
| push: | ||
| branches: | ||
| - main | ||
| paths-ignore: | ||
| - "docs/**" | ||
| - "**.md" | ||
| - ".vscode/**" | ||
| - ".idea/**" | ||
|
|
||
| permissions: | ||
| contents: read | ||
| packages: read | ||
|
|
||
| jobs: | ||
| lint-and-build: | ||
| name: CI dApp | ||
| uses: ./.github/workflows/checks.yaml | ||
| {%- if cloud_provider == 'netlify' %} | ||
| with: | ||
| run-build: true | ||
| {% endif %} | ||
|
|
||
| deploy: | ||
| runs-on: ubuntu-latest | ||
| name: Deploy to {% if cloud_provider == 'vercel' %}Vercel{% else %}Netlify{% endif %} | ||
| environment: Prod | ||
| concurrency: {% raw %}"${{ github.workflow }}-prod"{% endraw %} | ||
| needs: | ||
| - lint-and-build | ||
| steps: | ||
| - name: Checkout code | ||
| uses: actions/checkout@v2 | ||
|
|
||
| {%- if cloud_provider == 'vercel' %} | ||
| {% raw %} | ||
| - name: Install Vercel CLI | ||
| run: npm install --global vercel@latest | ||
| - name: Pull Vercel Environment Information | ||
| run: vercel pull --yes --environment=production --token=${{ secrets.VERCEL_TOKEN }} | ||
| - name: Build Project Artifacts | ||
| run: vercel build --prod --token=${{ secrets.VERCEL_TOKEN }} | ||
| - name: Deploy Project Artifacts to Vercel | ||
| run: vercel deploy --prebuilt --prod --token=${{ secrets.VERCEL_TOKEN }} | ||
| # Set your vercel project env variables on your site instance on https://vercel.com/dashboard | ||
| {% endraw %} | ||
| {%- else %} | ||
| {% raw %} | ||
| - name: Download build artifacts | ||
| uses: actions/download-artifact@v3 | ||
| with: | ||
| name: dist | ||
| path: dist | ||
|
|
||
| - name: Install netlify cli | ||
| run: npm i netlify-cli | ||
|
|
||
| - name: Publish to netlify | ||
| run: netlify deploy --prod --dir "dist" | ||
| env: | ||
| NETLIFY_SITE_ID: ${{ secrets.NETLIFY_SITE_ID }} | ||
| NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_AUTH_TOKEN }} | ||
|
|
||
| # Pass your environment variables here, e.g., | ||
| # VITE_ALGOD_NODE_CONFIG_TOKEN: ${{ secrets.VITE_ALGOD_NODE_CONFIG_TOKEN }} | ||
| # VITE_ALGOD_NODE_CONFIG_SERVER: ${{ secrets.VITE_ALGOD_NODE_CONFIG_SERVER }} | ||
| # VITE_ALGOD_NODE_CONFIG_PORT: ${{ secrets.VITE_ALGOD_NODE_CONFIG_PORT }} | ||
|
|
||
| # VITE_INDEXER_TOKEN: ${{ secrets.VITE_INDEXER_TOKEN }} | ||
| # VITE_INDEXER_SERVER: ${{ secrets.VITE_INDEXER_SERVER }} | ||
| # VITE_INDEXER_PORT: ${{ secrets.VITE_INDEXER_PORT }} | ||
|
|
||
| # VITE_ALGOD_NETWORK: ${{ secrets.VITE_ALGOD_NETWORK }} | ||
| {% endraw %} | ||
| {%- endif %} |
Oops, something went wrong.