Merge pull request #27 from EventStore/brock/lint-md

lint markdown

.github/workflows/lint.yml

@@ -0,0 +1,23 @@
+name: Linting Check on Markdown
+on:
+  push:
+    branches:
+      - '*'
+  pull_request:
+    branches:
+      - '*'
+jobs:
+  lint:
+    name: markdown lint check
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: Set up NodeJS
+        uses: actions/setup-node@v2
+      - name: Install pulumictl
+        run: curl -L https://github.com/pulumi/pulumictl/releases/download/v0.0.46/pulumictl-v0.0.46-linux-amd64.tar.gz | sudo tar zxv -C /usr/bin -f- pulumictl
+      - name: Lint markdown
+        run: |
+          yarn install
+          make lint

.gitignore

@@ -18,4 +18,6 @@ yarn.lock
 
 **/schema-embed.json
 **/version.txt
+pulumi-eventstorecloud.sln
 
+node_modules

Makefile

@@ -20,6 +20,10 @@ WORKING_DIR     := $(shell pwd)
 OS := $(shell uname)
 EMPTY_TO_AVOID_SED := ""
 
+.PHONY: lint
+lint:
+	./scripts/lint.sh
+
 prepare::
 	@if test -z "${NAME}"; then echo "NAME not set"; exit 1; fi
 	@if test -z "${REPOSITORY}"; then echo "REPOSITORY not set"; exit 1; fi

docs/installation-configuration.md

@@ -8,9 +8,9 @@ layout: package
 
 The Event Store Cloud provider is available as a package in all Pulumi languages:
 
--   JavaScript/TypeScript: [`@eventstore/pulumi-eventstorecloud`](https://www.npmjs.com/package/@eventstore/pulumi-eventstorecloud)
--   Go: [`github.com/EventStore/pulumi-eventstorecloud/sdk/go/eventstorecloud`](https://github.com/EventStore/pulumi-eventstorecloud)
--   .NET: [`Pulumi.EventStoreCloud`](https://www.nuget.org/packages/Pulumi.EventStoreCloud)
+- JavaScript/TypeScript: [`@eventstore/pulumi-eventstorecloud`](https://www.npmjs.com/package/@eventstore/pulumi-eventstorecloud)
+- Go: [`github.com/EventStore/pulumi-eventstorecloud/sdk/go/eventstorecloud`](https://github.com/EventStore/pulumi-eventstorecloud)
+- .NET: [`Pulumi.EventStoreCloud`](https://www.nuget.org/packages/Pulumi.EventStoreCloud)
 
 ## Setup
 
@@ -33,8 +33,8 @@ First, you need an [access token](https://developers.eventstore.com/cloud/automa
 
 Then, go to the list of organizations you have access to in Event Store Cloud console, choose the organization that you will be provisioning resources for, and look the organization id in the settings.
 
--   `<YOUR_ACCESS_TOKEN>`: your access token
--   `<YOUR_ORGANIZATION_ID>`: the Event Store Cloud organization id
+- `<YOUR_ACCESS_TOKEN>`: your access token
+- `<YOUR_ORGANIZATION_ID>`: the Event Store Cloud organization id
 
 Once the credentials are obtained, there are two ways to communicate your authorization tokens to Pulumi:
 

package.json

@@ -0,0 +1,11 @@
+{
+    "name": "pulumi-eventstorecloud",
+    "version": "0.0.1",
+    "repository": "git@github.com/EventStore/pulumi-eventstorecloud",
+    "author": "Brock Shelton <brock.shelton@eventstore.com>",
+    "license": "Apache-2.0",
+    "dependencies": {
+        "js-yaml": "^4.1.0",
+        "markdownlint": "^0.28.0"
+    }
+}

scripts/lint.sh

@@ -0,0 +1,3 @@
+#!/bin/bash
+
+node ./scripts/lint/lint-markdown.js $1