Init browserstack orb

.circleci/config.yml

@@ -0,0 +1,29 @@
+version: 2.1
+setup: true
+orbs:
+  orb-tools: circleci/[email protected]
+  shellcheck: circleci/[email protected]
+
+filters: &filters
+  tags:
+    only: /.*/
+
+workflows:
+  lint-pack:
+    jobs:
+      - orb-tools/lint:
+          filters: *filters
+      - orb-tools/pack:
+          filters: *filters
+      - orb-tools/review:
+          orb_name: browserstack-circleci-orb
+          filters: *filters
+      - shellcheck/check:
+          filters: *filters
+      # Triggers the next workflow in the Orb Development Kit.
+      - orb-tools/continue:
+          pipeline_number: << pipeline.number >>
+          vcs_type: github
+          orb_name: browserstack-circleci-orb
+          requires: [orb-tools/lint, orb-tools/pack, orb-tools/review, shellcheck/check]
+          filters: *filters

.circleci/test-deploy.yml

@@ -0,0 +1,51 @@
+version: 2.1
+orbs:
+  # Your orb will be automatically injected here during the pipeline.
+  # Reference your orb's jobs and commands below as they will exist when built.
+  orb-tools: circleci/[email protected]
+  # The orb definition is intentionally not included here. It will be injected into the pipeline.
+  browserstack-circleci-orb: {}
+
+# Use this tag to ensure test jobs always run,
+# even though the downstream publish job will only run on release tags.
+filters: &filters
+  tags:
+    only: /.*/
+
+# Filter for release tags.
+release-filters: &release-filters
+  branches:
+    ignore: /.*/
+  tags:
+    only: /^v[0-9]+\.[0-9]+\.[0-9]+$/
+
+jobs:
+  # Create jobs to test the commands of your orbs.
+  # You may want to add additional validation steps to ensure the commands are working as expected.
+  command-test:
+    docker:
+      - image: cimg/base:current
+    steps:
+      - checkout
+      # Run your orb's commands to validate them.
+      - browserstack-circleci-orb/set_rerun_tests
+workflows:
+  test-deploy:
+    jobs:
+      # Make sure to include "filters: *filters" in every test job you want to run as part of your deployment.
+      # Test your orb's commands in a custom job and test your orb's jobs directly as a part of this workflow.
+      - command-test:
+          filters: *filters
+      # The orb must be re-packed for publishing, and saved to the workspace.
+      - orb-tools/pack:
+          filters: *release-filters
+      - orb-tools/publish:
+          orb_name: browserstack/browserstack-circleci-orb
+          vcs_type: github
+          pub_type: production
+          # Ensure this job requires all test jobs and the pack job.
+          requires:
+            - orb-tools/pack
+            - command-test
+          context: orb-publishing
+          filters: *release-filters

.github/ISSUE_TEMPLATE/BUG.yml

@@ -0,0 +1,41 @@
+name: "\U0001F41E  Bug Report"
+description: Report any identified bugs.
+title: 'Bug: '
+labels: [bug]
+# assignees: ''
+body:
+  - type: checkboxes
+    attributes:
+      label: "Is there an existing issue for this?"
+      description: "Please search [here](https://github.com/<organization>/<project-name>/issues?q=is%3Aissue) to see if an issue already exists for the bug you encountered"
+      options:
+      - label: "I have searched the existing issues"
+        required: true
+
+  - type: input
+    attributes:
+      label: "Orb version"
+      description: |
+        Which version of `<namespace>/<orb-name>` are you using?
+      placeholder: "1.0.0"
+
+  - type: textarea
+    validations:
+      required: true
+    attributes:
+      label: "Current behavior"
+      description: "How does the issue manifest?"
+
+  - type: textarea
+    validations:
+      required: true
+    attributes:
+      label: "Minimum reproduction config"
+      description: "Enter a URL to a failed build or write a config example to reproduce the issue"
+      placeholder: "https://app.circleci.com/..."
+
+  - type: textarea
+    attributes:
+      label: "Other"
+      description: |
+        Anything else you want to share?

.github/ISSUE_TEMPLATE/FEATURE_REQUEST.yml

@@ -0,0 +1,34 @@
+name: "\U0001F4A1 Feature Request"
+description: Have an idea for a new feature? Begin by submitting a Feature Request
+title: 'Request: '
+labels: [enhancement]
+# assignees: ''
+body:
+  - type: checkboxes
+    attributes:
+      label: "Is there an existing issue that is already proposing this?"
+      description: "Please search [here](https://github.com/CircleCI-Public/circleci-config-sdk-ts/issues?q=is%3Aissue) to see if an issue already exists for the feature you are requesting"
+      options:
+      - label: "I have searched the existing issues"
+        required: true
+
+  - type: textarea
+    validations:
+      required: true
+    attributes:
+      label: "Describe the problem imposed by not having this feature"
+      description: "Please describe the use-case you are attempting to implement, and the current limitations you are facing."
+
+  - type: textarea
+    validations:
+      required: true
+    attributes:
+      label: "Describe the solution you'd like"
+      description: "A clear and concise description of what you want to happen. Add any considered drawbacks"
+
+
+  - type: textarea
+    attributes:
+      label: "Other"
+      description: |
+        Anything else you want to share?

.github/PULL_REQUEST_TEMPLATE/PULL_REQUEST.md

@@ -0,0 +1,25 @@
+## PR Type
+What kind of change does this PR introduce?
+
+<!-- Please check the one that applies to this PR using "x". -->
+- [ ] Bugfix
+- [ ] Feature
+- [ ] Code style update (formatting)
+- [ ] Refactoring (no functional changes)
+- [ ] CI related changes
+- [ ] Other... Please describe:
+
+## What is the current behavior?
+<!-- Please describe the current behavior that you are modifying, or link to a relevant issue. -->
+
+Issue Number: N/A
+
+## What is the new behavior?
+
+## Does this PR introduce a breaking change?
+- [ ] Yes
+- [ ] No
+
+<!-- If this PR contains a breaking change, please describe the impact and migration path for existing applications below. -->
+
+## Other information

.gitignore

@@ -0,0 +1,4 @@
+# orb.yml is "packed" from source, and not published directly from the repository.
+orb.yml
+.DS_Store
+.idea

.yamllint

@@ -0,0 +1,7 @@
+extends: relaxed
+
+rules:
+    line-length:
+        max: 200
+        allow-non-breakable-inline-mappings: true
+

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 <organization>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

src/@orb.yml

@@ -0,0 +1,15 @@
+version: 2.1
+
+description: >
+  Browserstack orb to set custom job-scope variables for a user config.
+# What will your orb allow users to accomplish?
+# Descriptions should be short, simple, and informative.
+
+# This information will be displayed in the orb registry and is not mandatory.
+display:
+  home_url: "https://browserstack.com"
+  source_url: "https://github.com/browserstack/browserstack-circleci-orb"
+
+# If your orb requires other orbs, you can import them like this. Otherwise remove the "orbs" stanza.
+# orbs:
+#  hello: circleci/[email protected]

src/README.md

@@ -0,0 +1,26 @@
+# Orb Source
+
+Orbs are shipped as individual `orb.yml` files, however, to make development easier, it is possible to author an orb in _unpacked_ form, which can be _packed_ with the CircleCI CLI and published.
+
+The default `.circleci/config.yml` file contains the configuration code needed to automatically pack, test, and deploy any changes made to the contents of the orb source in this directory.
+
+## @orb.yml
+
+This is the entry point for our orb "tree", which becomes our `orb.yml` file later.
+
+Within the `@orb.yml` we generally specify 4 configuration keys
+
+**Keys**
+
+1. **version**
+    Specify version 2.1 for orb-compatible configuration `version: 2.1`
+2. **description**
+    Give your orb a description. Shown within the CLI and orb registry
+3. **display**
+    Specify the `home_url` referencing documentation or product URL, and `source_url` linking to the orb's source repository.
+4. **orbs**
+    (optional) Some orbs may depend on other orbs. Import them here.
+
+## See:
+ - [Orb Author Intro](https://circleci.com/docs/2.0/orb-author-intro/#section=configuration)
+ - [Reusable Configuration](https://circleci.com/docs/2.0/reusing-config)

src/commands/set_rerun_tests.yml

@@ -0,0 +1,8 @@
+description: "Cleanup the project level environment variable set by browserstack rerun API"
+
+steps:
+  - run:
+      name: Set Rerun Tests
+      command: <<include(scripts/rerun_tests.sh)>>
+      environment:
+        CLEANUP_ENV_VAR: true

src/examples/cleanup_env.yml

@@ -0,0 +1,14 @@
+description: |
+  This example demonstrates how to use the BrowserStack CircleCI Orb to clean up the project environment variables after the test execution.
+
+usage:
+  version: 2.1
+  orbs:
+    browserstack-circleci-orb: browserstack/[email protected]
+  workflows:
+    cleanup-job-example:
+      jobs:
+        - my_test_job
+        - browserstack-circleci-orb/cleanup_env:
+            requires:
+              - my_test_job

src/examples/set_rerun_tests.yml

@@ -0,0 +1,23 @@
+description: |
+  This example demonstrates how to use browserstack rerun tests command & set it in job environment variable.
+
+usage:
+  version: 2.1
+  orbs:
+    browserstack-circleci-orb: browserstack/[email protected]
+
+  jobs:
+    my_test_job:
+      executor: default
+      steps:
+        - checkout
+        - browserstack-circleci-orb/set_rerun_tests:
+            delete_env_var: true # Default value is False
+        - run:
+            name: Run Test
+            command: |
+              echo "Bs Tests: $BSTACK_RERUN_TESTS"
+  workflows:
+    set-rerun-tests-example:
+      jobs:
+        - my_test_job

src/executors/default.yml

@@ -0,0 +1,12 @@
+description: >
+  This is a sample executor using Docker and Node. If you want to provide a custom environment in your orb, insert your image here.
+  If you do not require an executor, you can simply delete this directory.
+docker:
+  - image: 'cimg/node:<<parameters.tag>>'
+parameters:
+  tag:
+    default: lts
+    description: >
+      Pick a specific cimg/node image variant:
+      https://hub.docker.com/r/cimg/node/tags
+    type: string

src/jobs/cleanup_env.yml

@@ -0,0 +1,10 @@
+description: "Cleanup the project level environment variable"
+
+executor: default
+
+steps:
+  - run:
+      name: Cleanup Environment
+      command: <<include(scripts/rerun_tests.sh)>>
+      environment:
+        CLEANUP_ENV_VAR: true