Merge pull request #63 from sophos-factory/release-v1.0.3-rc.1

Pre-release, update docs

CONTRIBUTING.md

@@ -0,0 +1,44 @@
+# Contributing
+
+Contributions are welcome!
+
+Please note the library is generated from the OpenAPI schema at: `https://api.refactr.it/v1`.
+
+This repository generates the schema (at [`spec/schema.json`](spec/schema.json)) using [a workflow](.github/workflows/gen.yml).
+
+## Clone
+
+Clone the repository: 
+
+```sh
+git clone https://github.com/sophos-factory/api-client.git
+```
+
+## Issues and Branches
+
+If you'd like to let us know about a request or bug, please open an issue.
+
+In order to make changes to the project, please check out a new branch. If your changes are associated with an issue, please include it in the branch name. For example:
+
+```txt
+1279/add-license
+```
+
+or
+
+```txt
+123/update-readme
+```
+
+## Pull Requests
+
+Please include any issue references in the PR title, for example:
+
+```txt
+[#1279] Add license
+```
+
+You can help us to understand your changes with a brief description.
+
+Thank you for your contributions!
+

RELEASE.md

@@ -18,3 +18,13 @@ This document describes the process for creating a release and publishing a new
 7. Publishing a release triggers the GitHub Action [Publish to npm](.github/workflows/release.yml) which will release the new npm package automatically. Ensure the Action completes successfully.
 
 New updates can be viewed at the npm package page: https://www.npmjs.com/package/@sophos-factory/api-client
+
+## Publishing a Pre-Release
+
+1. Do steps 1-4 above.
+2. Ensure you have the correct npm credentials set up locally.
+3. Publish the pre-release using [`npm publish`](https://docs.npmjs.com/cli/v8/commands/npm-publish) and ensure you pass the pre-release `--tag`. For example:
+
+    ```sh
+    npm publish --tag v1.0.3-rc.1 --access public
+    ```

package.json

@@ -28,7 +28,7 @@
     "README.md"
   ],
   "dependencies": {
-    "@sophos-factory/api-client": "^1.0.0",
+    "@sophos-factory/api-client": "1.0.2",
     "axios": "^0.21.2"
   },
   "devDependencies": {