Merge pull request #1 from mathrix-education/dev

chore(release): release 0.1.0

Author: matbour

.github/workflows/tests.yml

@@ -0,0 +1,48 @@
+name: Tests
+on: push
+jobs:
+  test:
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+        version: [latest, 1.49.0]
+      fail-fast: false
+    runs-on: ${{ matrix.os }}
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v1
+      - name: Setup Node.js 12
+        uses: actions/setup-node@v1.2.0
+        with:
+          node-version: 12.x
+      - name: Install Sentry CLI
+        run: node dist/index.js
+        env:
+          INPUT_VERSION: ${{ matrix.version }}
+          INPUT_URL: ${{ secrets.SENTRY_URL }}
+          INPUT_TOKEN: ${{ secrets.SENTRY_AUTH_TOKEN }}
+          INPUT_ORGANIZATION: ${{ secrets.SENTRY_ORGANIZATION }}
+          INPUT_PROJECT: ${{ secrets.SENTRY_PROJECT }}
+      - name: Display Sentry CLI info
+        run: |
+          sentry-cli --help
+          sentry-cli info
+      - name: Make release
+        if: contains(matrix.os, 'ubuntu') && matrix.version == 'latest'  # do not duplicate releases
+        run: |
+          VERSION=`sentry-cli releases propose-version`
+          sentry-cli releases new "$VERSION"
+          sentry-cli releases set-commits "$VERSION" --auto
+          sentry-cli releases files "$VERSION" upload-sourcemaps ./dist \
+            --rewrite \
+            --ext map \
+            --validate \
+            --verbose \
+            --strip-common-prefix
+          sentry-cli releases finalize "$VERSION"
+      - name: Send test event
+        if: contains(matrix.os, 'ubuntu') && matrix.version == 'latest'  # do not duplicate events
+        run: |
+          export SENTRY_DSN=${{ secrets.SENTRY_DSN }}
+          sentry-cli send-event -m "Hello from GitHub Actions"
+

.gitignore

@@ -0,0 +1,2 @@
+.idea/
+node_modules/

.huskyrc.js

@@ -0,0 +1,7 @@
+const tasks = commands => commands.join(' && ');
+
+module.exports = {
+  hooks: {
+    'pre-commit': tasks(['npm run build', 'git add dist/']),
+  },
+};

README.md

@@ -0,0 +1,105 @@
+# mathrix-education/setup-sentry-cli
+Install the Sentry CLI in your GitHub Actions workflow.
+
+**This action is not supported by Sentry.**
+
+Proudly maintained by [Mathieu Bour][1.1], Vice-CTO
+[@mathrix-education][1.2].
+
+[1.1]: https://github.com/mathieu-bour
+[1.2]: https://github.com/mathrix-education
+
+## Motivations
+Installing Sentry CLI in GitHub Actions can be relevant in many cases.
+Mathrix Education SA is based on Angular, which produces sourcemaps.
+Therefore, we need to upload sourcemaps, during our compilation
+workflow.
+
+There is an
+[official guide to use sentry-cli on the Sentry's blog][2.1],
+but it requires to use a bunch of commands, which is not really
+straight forward.
+
+There are also some [Docker-based actions][2.2], but they are quite
+slow.
+
+[2.1]: https://blog.sentry.io/2019/12/17/using-github-actions-to-create-sentry-releases
+[2.2]: https://github.com/marketplace?type=actions&query=sentry
+
+
+## Usage
+### Supported operating systems
+This action currently supports Ubuntu, Windows and Mac-OS based systems.
+The supported operating systems matrix is the following:
+
+| Operating system | Status |
+|------------------|-------|
+| `ubuntu-latest`  | ![3.1] |
+| `macos-latest`   | ![3.1] |
+| `windows-latest` | ![3.1] |
+
+[3.1]: https://img.shields.io/badge/status-supported-brightgreen
+
+### Inputs
+| Name           | Type                  | Default value |
+|----------------|-----------------------|---------------|
+| `version`      | `'latest'` / `string` | `'latest'`    |
+| `token`        | `string`              | `''`          |
+| `url`          | `string`              | `''`          |
+| `organization` | `string`              | `''`          |
+| `project`      | `string`              | `''`          |
+
+See [action.yml](action.yml) for details.
+
+#### `version`
+If you need a precise version of the Sentry CLI, you may provide this
+input. We strongly advise you to do so since using the latest version
+may break your workflow if Sentry releases a backward-incompatible
+version.
+
+#### `url`
+The Sentry server URL. By default, this action will configure the
+Sentry CLI to interact with official Sentry server which is
+`https://sentry.io`. If you use an on-premise instance, you may provide
+your server URL here.
+
+#### `token`
+This is the token which will be used by the Sentry CLI to authenticate
+against the Sentry server.
+You may generate it on your personal account page.
+
+#### `organization`
+Define the default organization.
+
+#### `project`
+Define the default project.
+
+## Examples
+### Minimal configuration
+```yaml
+- uses: mathrix-education/setup-sentry-cli@master
+```
+By default, this minimal example will install the latest version of the
+Sentry CLI, without any authentication.
+
+### Typical CI configuration
+```yaml
+- name: Setup Sentry CLI
+  uses: mathrix-education/setup-sentry-cli@0.1.0
+  with:
+    version: latest # optional if 'latest'
+    url: https://sentry.yourcompany.com
+    auth: ${{ SECRETS.SENTRY_TOKEN }} # from GitHub secrets
+    organization: my-org
+    project: my-project
+```
+In this example, you provide a authentication token. The action
+automatically download the latest version of the Sentry CLI and
+authenticate using the provided token.
+
+Then, the CLI is configured for the server
+`https://sentry.yourcompany.com` and the project `my-project` of the
+organization `my-org`.
+
+You are now ready to use the Sentry CLI commands such as
+`sentry-cli releases`!

action.yml

@@ -0,0 +1,26 @@
+name: Setup Sentry CLI
+description: Setup the Sentry CLI
+author: Mathrix Education SA
+branding:
+  color: orange
+  icon: triangle
+runs:
+  using: 'node12'
+  main: 'dist/index.js'
+inputs:
+  version:
+    description: Sentry CLI version to use. By default, the action will use the latest one.
+    required: false
+    default: latest
+  token:
+    description: Authentication token to use. If not provided, you will have to authenticate yourself later.
+    required: false
+  url:
+    description: Sentry server URL. By default, sentry-cli will use https://sentry.io.
+    required: false
+  organization:
+    description: Default Sentry organization.
+    required: false
+  project:
+    description: Default Sentry project.
+    required: false