testsigmahq · PratheepV · Oct 12, 2022 · Jan 24, 2022 · Jan 24, 2022 · Jan 24, 2022
diff --git a/.github/workflows/cd.yml b/.github/workflows/cd.yml
@@ -0,0 +1,43 @@
+name: 'CD'
+on:
+  push:
+    branches:
+      - 'main'
+jobs:
+  Deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Install libvips
+        run: sudo apt-get install libvips
+      - uses: actions/checkout@v2
+      - name: Setup Node 12
+        uses: actions/setup-node@v2
+        with:
+          node-version: '12'
+      - name: Install dependencies
+        run: |
+          npm ci --ignore-scripts --unsafe-perm
+      - name: Force installing sharp
+        run: npm install --ignore-scripts=false --verbose sharp
+      - name: 'Create env file'
+        run: |
+          touch .env
+          echo GATSBY_ALGOLIA_APP_ID=${{ secrets.GATSBY_ALGOLIA_APP_ID }} >> .env
+          echo GATSBY_ALGOLIA_SEARCH_KEY=${{ secrets.GATSBY_ALGOLIA_SEARCH_KEY }} >> .env
+          echo ALGOLIA_ADMIN_KEY=${{ secrets.ALGOLIA_ADMIN_KEY }} >> .env
+          echo BUCKET_NAME=${{ secrets.BUCKET_NAME }} >> .env
+          echo HOST_NAME=${{ secrets.HOST_NAME }} >> .env
+          echo ASSET_HOST=${{ secrets.ASSET_HOST }} >> .env
+          echo FRESHCHAT_TOKEN=${{ secrets.FRESHCHAT_TOKEN }} >> .env
+          echo GA_TRACKING_ID=${{ secrets.GA_TRACKING_ID }} >> .env
+          echo GTAG_TRACKING_ID_FOR_GA4=${{ secrets.GTAG_TRACKING_ID_FOR_GA4 }} >> .env
+          echo GTAG_TRACKING_ID_FOR_GTAG=${{ secrets.GTAG_TRACKING_ID_FOR_GTAG }} >> .env
+          cat .env
+      - name: Build
+        run: |
+          PREFIX_PATHS=true npm run build && npm run deploy
+        env:
+          AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
+          AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
+          AWS_DEFAULT_REGION: 'us-east-1'
+          AWS_DEFAULT_OUTPUT: json
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -0,0 +1,37 @@
+name: 'CI'
+on:
+  pull_request:
+    types: [ opened, synchronize, reopened ]
+jobs:
+  CI:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Install libvips
+        run: sudo apt-get install libvips
+      - uses: actions/checkout@v2
+      - name: Setup Node 12
+        uses: actions/setup-node@v2
+        with:
+          node-version: '12'
+      - name: Install dependencies
+        run: |
+          npm ci --ignore-scripts --unsafe-perm
+      - name: Force installing sharp
+        run: npm install --ignore-scripts=false --verbose sharp@0.30.7
+      - name: 'Create env file'
+        run: |
+          touch .env
+          echo GATSBY_ALGOLIA_APP_ID=${{ secrets.GATSBY_ALGOLIA_APP_ID }} >> .env
+          echo GATSBY_ALGOLIA_SEARCH_KEY=${{ secrets.GATSBY_ALGOLIA_SEARCH_KEY }} >> .env
+          echo ALGOLIA_ADMIN_KEY=${{ secrets.ALGOLIA_ADMIN_KEY }} >> .env
+          echo BUCKET_NAME=${{ secrets.BUCKET_NAME }} >> .env
+          echo HOST_NAME=${{ secrets.HOST_NAME }} >> .env
+          echo ASSET_HOST=${{ secrets.ASSET_HOST }} >> .env
+          echo FRESHCHAT_TOKEN=${{ secrets.FRESHCHAT_TOKEN }} >> .env
+          echo GA_TRACKING_ID=${{ secrets.GA_TRACKING_ID }} >> .env
+          echo GTAG_TRACKING_ID_FOR_GA4=${{ secrets.GTAG_TRACKING_ID_FOR_GA4 }} >> .env
+          echo GTAG_TRACKING_ID_FOR_GTAG=${{ secrets.GTAG_TRACKING_ID_FOR_GTAG }} >> .env
+          cat .env
+      - name: Build
+        run: |
+          PREFIX_PATHS=true npm run build
diff --git a/.github/workflows/staging-cd.yml b/.github/workflows/staging-cd.yml
@@ -0,0 +1,43 @@
+name: 'Staging CD'
+on:
+  push:
+    branches:
+      - 'dev'
+jobs:
+  StagingDeploy:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Install libvips
+        run: sudo apt-get install libvips
+      - uses: actions/checkout@v2
+      - name: Setup Node 12
+        uses: actions/setup-node@v2
+        with:
+          node-version: '12'
+      - name: Install dependencies
+        run: |
+          npm ci --ignore-scripts --unsafe-perm
+      - name: Force installing sharp
+        run: npm install --ignore-scripts=false --verbose sharp@0.30.7
+      - name: 'Create env file'
+        run: |
+          touch .env
+          echo GATSBY_ALGOLIA_APP_ID=${{ secrets.STAGING_GATSBY_ALGOLIA_APP_ID }} >> .env
+          echo GATSBY_ALGOLIA_SEARCH_KEY=${{ secrets.STAGING_GATSBY_ALGOLIA_SEARCH_KEY }} >> .env
+          echo ALGOLIA_ADMIN_KEY=${{ secrets.STAGING_ALGOLIA_ADMIN_KEY }} >> .env
+          echo BUCKET_NAME=${{ secrets.STAGING_BUCKET_NAME }} >> .env
+          echo HOST_NAME=${{ secrets.STAGING_HOST_NAME }} >> .env
+          echo ASSET_HOST=${{ secrets.STAGING_ASSET_HOST }} >> .env
+          echo FRESHCHAT_TOKEN=${{ secrets.STAGING_FRESHCHAT_TOKEN }} >> .env
+          echo GA_TRACKING_ID=${{ secrets.STAGING_GA_TRACKING_ID }} >> .env
+          echo GTAG_TRACKING_ID_FOR_GA4=${{ secrets.STAGING_GTAG_TRACKING_ID_FOR_GA4 }} >> .env
+          echo GTAG_TRACKING_ID_FOR_GTAG=${{ secrets.STAGING_GTAG_TRACKING_ID_FOR_GTAG }} >> .env
+          cat .env
+      - name: Build
+        run: |
+          PREFIX_PATHS=true npm run build && npm run deploy
+        env:
+          AWS_ACCESS_KEY_ID: ${{ secrets.STAGING_AWS_ACCESS_KEY_ID }}
+          AWS_SECRET_ACCESS_KEY: ${{ secrets.STAGING_AWS_SECRET_ACCESS_KEY }}
+          AWS_DEFAULT_REGION: 'us-east-1'
+          AWS_DEFAULT_OUTPUT: json
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,7 @@
+node_modules/
+.cache/
+public
+.idea/*
+*.iml
+.env
+.DS_Store
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -0,0 +1,133 @@
+
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders of this open-source project pledge 
+to make participation in our community and contribution to our project an 
+inclusive experience for everyone, regardless of age, body size, visible or 
+invisible disability, ethnicity, gender identity, and expression, sexual identity 
+and orientation, level of experience, education, socio-economic status, 
+nationality, personal appearance, race, caste, color, or religion.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people.
+* Being respectful of differing opinions, viewpoints, and experiences.
+* Giving and gracefully accepting constructive feedback.
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience.
+* Focusing on what is best not just for us as individuals, but for the overall
+  community.
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+community@testsigma.com
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,60 @@
+# Contributing to Tutorials
+
+Testsigma docs are built using [Gatsby](https://www.gatsbyjs.com/) and deployed to [https://testsigma.com/tutorials/.](https://testsigma.com/tutorials/)
+
+If you feel insecure about how to start contributing, feel free to ask us on our [Discord Server](https://discord.com/invite/5caWS7R6QX), in the #contributors channel. 
+
+## **Code of conduct**
+
+Read our [Code of Conduct](CODE_OF_CONDUCT.md) before contributing.
+
+## **Getting Started**
+
+We use [Github Flow](https://guides.github.com/introduction/flow/index.html), so all code changes happen through pull requests. [Learn more.](https://blog.scottlowe.org/2015/01/27/using-fork-branch-git-workflow/)) 
+
+1. Please make sure there is an issue associated with the work that you're doing. If it doesn’t exist, [create an issue.](https://github.com/testsigmahq/testsigma-tutorials/issues/new/choose)
+2. If you're working on an issue, please comment that you are doing so to prevent duplicate work by others also.
+3. Fork the repo and create a new branch from the `main` branch.
+4. Please name the branch as issue-[issue-number]-[issue-name(optional)]. For example, if you are fixing Issue #205 name your branch as issue-205 or  issue-205-how to-automate-date-widget
+6. Squash your commits and refer to the issue using `Fix #<issue-no>` in the commit message, at the start.
+7. Rebase `main` with your branch and push your changes.
+
+#### 🏡 Setup for local development
+ 1. Git clone:  `git clone git@github.com:testsigmahq/testsigma-tutorials.git`
+ 2. `cd testsigma-tutorials`
+ 3. Create a branch `git checkout -b issue-[issue-number]-[issue-name(optional)]`
+ 4. `cd testsigma-tutorials`
+ 5. `npm install`
+ 6. `npm start`
+
+Now you can access tutorials on your local server using http://localhost:8000/tutorials/
+
+
+## **Committing code**
+
+The main branch (protected) contains the code that is tested and released. Pull requests should be made against the main branch. `main` contains all of the new changes that ready to go out in the next update.
+
+Once you are done with the code changes on your local machine, follow the below steps to commit.
+
+#### **Commit & Create Pull Requests** 
+1. Please make sure there is an issue associated with the work that you're doing. If it doesn’t exist, [create an issue.](https://github.com/testsigmahq/testsigma-tutorials/issues/new/choose)
+2. Squash your commits and refer to the issue using `Fix #<issue-no>` in the commit message, at the start.
+3. Rebase `main` with your branch and push your changes.
+4. Once you are confident in your code changes, create a pull request in your fork to the main branch in the testsigmahq/testsigma-tutorials base repository.
+5. Link the issue of the base repository in your Pull request description. [Guide](https://docs.github.com/en/free-pro-team@latest/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue)
+
+For all contributions, a CLA (Contributor License Agreement) needs to be signed [here](https://cla-assistant.io/testsigmahq/testsigma-tutorials) before (or after) the pull request has been submitted. A bot will prompt contributors to sign the CLA via a pull request comment, if necessary.
+
+
+####  **Commit messages**
+
+- The first line should be a summary of the changes, not exceeding 50
+  characters, followed by an optional body that has more details about the
+  changes. Refer to [this link](https://github.com/erlang/otp/wiki/writing-good-commit-messages)
+  for more information on writing good commit messages.
+
+- Don't add a period/dot (.) at the end of the summary line.
+
+## **Notes**
+- Tutorials are currently deployed manually. Changes will not reflect immediately after a PR gets merged.
+- The search is powered by [Algolia](https://www.algolia.com/) and is updated every day. Your local changes will not be reflected in search results