auth0-deploy-cli 7.14.3 → 7.15.1

package/.circleci/config.yml

@@ -66,30 +66,43 @@ jobs:
           name: Publish package
           command: npm publish
 
+  does_typescript_compile: 
+    docker:
+      - image: cimg/node:current
+    working_directory: ~/repo
+    steps:
+      - checkout
+      - run: npm ci
+      - run: npx tsc --noEmit
+
 workflows:
   version: 2
 
   e2e_test:
     jobs:
-      - e2e_test_as_node_module
+      - e2e_test_as_node_module:
+          name: E2E tests as Node module
       - e2e_test_as_cli:
+          name: E2E tests as CLI
           filters:
             branches:
               only: master
 
   unit_test:
     jobs:
+      - does_typescript_compile:
+          name: Does Typescript compile?
       - unit_test:
-          name: test_lts
+          name: Unit tests with Node LTS
           v: "lts"
       - unit_test:
-          name: test_current
+          name: Unit tests with Node current
           v: "current"
 
   test_and_deploy:
     jobs:
       - unit_test:
-          name: test_lts
+          name: Unit tests with Node LTS
           v: "lts"
           filters:
             branches:
@@ -97,9 +110,10 @@ workflows:
             tags:
               only: /^v.*/
       - deploy:
+          name: Publish to NPM
           v: "lts"
           requires:
-            - test_lts
+            - Unit tests with Node LTS
           filters:
             branches:
               ignore: /.*/

package/.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,8 @@
+blank_issues_enabled: false
+contact_links:
+  - name: 🤔 Help & Questions
+    url: https://community.auth0.com/c/sdks/5
+    about: Ask general support or usage questions in the Auth0 Community forums
+  - name: 📖 Deploy CLI Documentation
+    url: https://github.com/auth0/auth0-deploy-cli#documentation
+    about: Check the Deploy CLI documentation for in-depth overview of all the available commands

package/.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,50 @@
+name: 🚀 Feature Request
+description: Suggest an idea or a feature for this project
+labels: [ "feature request" ]
+
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill out this feature request!
+
+  - type: checkboxes
+    id: checklist
+    attributes:
+      label: Checklist
+      options:
+        - label: I agree to the terms within the [Auth0 Code of Conduct](https://github.com/auth0/open-source-template/blob/master/CODE-OF-CONDUCT.md).
+          required: true
+
+  - type: textarea
+    id: description
+    attributes:
+      label: Describe the problem you'd like to have solved
+      description: A clear and concise description of what the problem is.
+      placeholder: My life would be a lot simpler if...
+    validations:
+      required: true
+
+  - type: textarea
+    id: ideal-solution
+    attributes:
+      label: Describe the ideal solution
+      description: A clear and concise description of what you want to happen.
+    validations:
+      required: true
+
+  - type: textarea
+    id: alternatives-and-workarounds
+    attributes:
+      label: Alternatives and current workarounds
+      description: A clear and concise description of any alternatives you've considered or any workarounds that are currently in place.
+    validations:
+      required: false
+
+  - type: textarea
+    id: additional-context
+    attributes:
+      label: Additional context
+      description: Add any other context or screenshots about the feature request here.
+    validations:
+      required: false

package/.github/ISSUE_TEMPLATE/report_a_bug.yml

@@ -0,0 +1,74 @@
+name: 🐛 Report a bug
+description: Have you found a bug or issue? Create a bug report for this tool
+labels: [ "bug" ]
+
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill out this bug report!
+
+  - type: markdown
+    attributes:
+      value: |
+        **Please do not report security vulnerabilities here**. The [Responsible Disclosure Program](https://auth0.com/responsible-disclosure-policy) details the procedure for disclosing security issues.
+
+  - type: checkboxes
+    id: checklist
+    attributes:
+      label: Checklist
+      options:
+        - label: I have looked into the [README](https://github.com/auth0/auth0-deploy-cli#readme) and have not found a suitable solution or answer.
+          required: true
+        - label: I have looked into the [documentation](https://github.com/auth0/auth0-deploy-cli#documentation) and have not found a suitable solution or answer.
+          required: true
+        - label: I have searched the [issues](https://github.com/auth0/auth0-deploy-cli/issues) and have not found a suitable solution or answer.
+          required: true
+        - label: I have upgraded to the [latest version](https://github.com/auth0/auth0-deploy-cli/releases/latest) of this tool and the issue still persists.
+          required: true
+        - label: I have searched the [Auth0 Community](https://community.auth0.com/c/sdks/5) forums and have not found a suitable solution or answer.
+          required: true
+        - label: I agree to the terms within the [Auth0 Code of Conduct](https://github.com/auth0/open-source-template/blob/master/CODE-OF-CONDUCT.md).
+          required: true
+
+  - type: textarea
+    id: description
+    attributes:
+      label: Description
+      description: Provide a clear and concise description of the issue.
+    validations:
+      required: true
+
+  - type: textarea
+    id: expectation
+    attributes:
+      label: Expectation
+      description: Tell us about the behavior you expected to see.
+    validations:
+      required: true
+
+  - type: textarea
+    id: reproduction
+    attributes:
+      label: Reproduction
+      description: Detail the steps taken to reproduce this error and, ideally, share a repo of a minimal reproducible example. State whether this issue can be reproduced consistently or if it is intermittent.
+      placeholder: |
+        1. Given...
+        2. When...
+        3. Then...
+    validations:
+      required: true
+
+  - type: input
+    id: environment-deploy-cli-version
+    attributes:
+      label: Deploy CLI version
+    validations:
+      required: true
+
+  - type: input
+    id: environment-node-version
+    attributes:
+      label: Node version
+    validations:
+      required: true

package/.github/PULL_REQUEST_TEMPLATE.md

@@ -1,24 +1,42 @@
-## ✏️ Changes
+<!--
+❗ For general support or usage questions, use the Auth0 Community forums or raise a support ticket.
 
-> DESCRIPTION GOES HERE. Try to describe both what is changing and why this is important
-> - Make sure you run  when adding / updating a package
-> - What did you change from a design standpoint?
-> - What did you change in the code itself?
-> - If you are updating a dependency, explain why this is needed.
+By submitting a pull request to this repository, you agree to the terms within the Auth0 Code of Conduct: https://github.com/auth0/open-source-template/blob/master/CODE-OF-CONDUCT.md.
+-->
 
-## 🔗 References
+### 🔧 Changes
 
-> Include at least one link to an explanation + requirements for this change, and more if at all possible. Typically this is a Jira/GitHub Issue, but could also be links to Zendesk tickets, RFCs, rollout plan or Slack conversations (for Slack conversations, make sure you provide a summary of the conversation under “Changes”).
+<!--
+Describe both what is changing and why this is important. Include:
 
-## 🎯 Testing
+- Types and methods added, deleted, deprecated, or changed
+- A summary of usage if this is a new feature or a change to a public API
+-->
 
-> Describe how this can be tested by reviewers. Please be specific about anything not tested and reasons why.
-> - Make sure you add unit and integration tests.
-> - If this is on a hot path, add load or performance tests
-> - Especially for dependency updates we also need to make sure that there is no impact on performance.
+### 📚 References
 
-✅🚫 This change has unit test coverage
+<!--
+Add relevant links supporting this change, such as:
 
-✅🚫 This change has integration test coverage
+- GitHub issue/PR number addressed or fixed
+- Auth0 Community post
+- StackOverflow answer
+- Related pull requests/issues from other repositories
 
-✅🚫 This change has been tested for performance
+If there are no references, simply delete this section.
+-->
+
+### 🔬 Testing
+
+<!--
+Describe how this can be tested by reviewers. Be specific about anything not tested and why. Include any manual steps for testing end-to-end, or for testing functionality not covered by unit tests.
+-->
+
+### 📝 Checklist
+
+- [ ] All new/changed/fixed functionality is covered by tests (or N/A)
+- [ ] I have added documentation for all new/changed functionality (or N/A)
+
+<!--
+❗ All the above items are required. Pull requests with an incomplete or missing checklist will be closed.
+-->