add PR comments and test instruction (#128)

* add PR comments and test instruction

* add main artifact in readme

.github/workflows/ci.yml

@@ -1,3 +1,5 @@
+name: CI
+
 on:
   push:
     branches:

.github/workflows/pr_comment.yml

@@ -0,0 +1,61 @@
+name: Comment on pull request
+on:
+  workflow_run:
+    workflows: [CI]
+    types: [completed]
+jobs:
+  pr_comment:
+    if: github.event.workflow_run.event == 'pull_request' && github.event.workflow_run.conclusion == 'success'
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/github-script@v6
+        with:
+          # This snippet is public-domain, taken from
+          # https://github.com/oprypin/nightly.link/blob/master/.github/workflows/pr-comment.yml
+          script: |
+            async function upsertComment(owner, repo, issue_number, purpose, body) {
+              const {data: comments} = await github.rest.issues.listComments(
+                {owner, repo, issue_number});
+
+              const marker = `<!-- bot: ${purpose} -->`;
+              body = marker + "\n" + body;
+
+              const existing = comments.filter((c) => c.body.includes(marker));
+              if (existing.length > 0) {
+                const last = existing[existing.length - 1];
+                core.info(`Updating comment ${last.id}`);
+                await github.rest.issues.updateComment({
+                  owner, repo,
+                  body,
+                  comment_id: last.id,
+                });
+              } else {
+                core.info(`Creating a comment in issue / PR #${issue_number}`);
+                await github.rest.issues.createComment({issue_number, body, owner, repo});
+              }
+            }
+
+            const {owner, repo} = context.repo;
+            const run_id = ${{github.event.workflow_run.id}};
+
+            const pull_requests = ${{ toJSON(github.event.workflow_run.pull_requests) }};
+            if (!pull_requests.length) {
+              return core.error("This workflow doesn't match any pull requests!");
+            }
+
+            const artifacts = await github.paginate(
+              github.rest.actions.listWorkflowRunArtifacts, {owner, repo, run_id});
+            if (!artifacts.length) {
+              return core.error(`No artifacts found`);
+            }
+            let body = `Download the artifacts for this pull request:\n`;
+            for (const art of artifacts) {
+              body += `\n* [${art.name}.zip](https://nightly.link/${owner}/${repo}/actions/artifacts/${art.id}.zip)`;
+            }
+
+            core.info("Review thread message body:", body);
+
+            for (const pr of pull_requests) {
+              await upsertComment(owner, repo, pr.number,
+                "nightly-link", body);
+            }

README.md

@@ -8,7 +8,7 @@ This repository contains a Javascript implementation of [esptool](https://github
 
 **CDN**
 
-`https://unpkg.com/esptool-js/lib/index.js?module`
+`https://unpkg.com/esptool-js/lib/index.js` or `https://unpkg.com/esptool-js/bundle.js` to use the single bundle JavaScript file.
 
 **NPM**
 
@@ -20,6 +20,8 @@ This repository contains a Javascript implementation of [esptool](https://github
 
 Check an example project [here](./examples/typescript).
 
+**Nightly builds** for <a href="https://nightly.link/espressif/esptool-js/workflows/ci/main">ESPTOOL-JS</a>
+
 ## Define port filters for device using WebSerial
 
 ```js
@@ -62,6 +64,20 @@ npm run dev # Run local sever with example code
 
 Then open `http://localhost:1234` in a Chrome browser. The `npm run build` step builds the `lib` used in the example `examples/typescript/index.html`. Update this reference as described in [Usage](#usage) section.
 
+## Test from Pull Request artifact
+
+If you are testing the main branch or any Pull Request (PR) artifact you can follow these steps:
+
+1. Get the `esptool-js-<version>.tgz` where `<version>` is the current version and download it.
+2. Add the following line to your project's package.json dependencies
+
+```json
+"dependencies": {
+  "esptool-js": "file:../path/to/esptool-js-<version>.tgz"
+}
+```
+3. Use the package like `import "esptool-js/lib/index.js"` when added in package.json as shown before.
+
 ## License
 
 The code in this repository is Copyright (c) 2023 Espressif Systems (Shanghai) Co. Ltd. It is licensed under Apache 2.0 license, as described in [LICENSE](LICENSE) file.