Skip to content
Open
Show file tree
Hide file tree
Changes from 10 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 38 additions & 0 deletions .github/workflows/aws-service-sanity-check.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
name: Main Branch Checks
permissions:
contents: read

on:
push:
branches-ignore:
- 'main'
- 'docs'

jobs:
verify-documentation-links:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Verify documentation files and links
# check if the files exists in the repository. The file list is in utils/doc-links.txt.
run: |
missing=0
while read -r file || [ -n "$file" ]; do
if [ ! -f "$file" ]; then
if [ $missing -eq 0 ]; then
echo "❌ Missing files referenced in AWS documentation:"
missing=$((missing + 1))
fi
echo " - $file"
fi
done < utils/doc-links.txt

if [ $missing -ge 1 ]; then
echo "Instructions:"
echo " The above files are required for AWS services or documentations."
echo " Restore missing files or update documentation before merge."
echo " Refer to team wiki "AWS Service and Documentation Links" for details. "
exit 1
else
echo "✅ All documentation-referenced files exist"
fi
4 changes: 2 additions & 2 deletions codebuild/cd/test-publish.sh
Original file line number Diff line number Diff line change
Expand Up @@ -42,12 +42,12 @@ if [ "$PUBLISHED_TAG_VERSION" == "$VERSION" ]; then
npm install

# Move to the sample folder and get the endpoint
cd samples/node/pub_sub
cd samples/node/mqtt/mqtt5_x509
ENDPOINT=$(aws secretsmanager get-secret-value --secret-id "ci/endpoint" --region us-east-1 --query "SecretString" | cut -f2 -d":" | sed -e 's/[\\\"\}]//g')

# Run the sample!
npm install
node dist/index.js --endpoint $ENDPOINT --ca_file /tmp/AmazonRootCA1.pem --cert /tmp/certificate.pem --key /tmp/privatekey.pem
node dist/index.js --endpoint $ENDPOINT --cert /tmp/certificate.pem --key /tmp/privatekey.pem

exit 0

Expand Down
7 changes: 3 additions & 4 deletions documents/FAQ.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@

### Where should I start?

If you are just getting started make sure you [install this sdk](https://github.com/aws/aws-iot-device-sdk-js-v2#installation) and then build and run the basic PubSub in [node](https://github.com/aws/aws-iot-device-sdk-js-v2/tree/main/samples/node/pub_sub_mqtt5) or in the [browser](https://github.com/aws/aws-iot-device-sdk-js-v2/tree/main/samples/browser/pub_sub_mqtt5)
If you are just getting started make sure you [install this sdk](https://github.com/aws/aws-iot-device-sdk-js-v2#installation) and then build and run the basic PubSub in [node](https://github.com/aws/aws-iot-device-sdk-js-v2/tree/main/samples/node/mqtt/mqtt5_x509) or in the [browser](https://github.com/aws/aws-iot-device-sdk-js-v2/tree/main/samples/browser/pub_sub_mqtt5)

### How do I enable logging?

Expand Down Expand Up @@ -57,14 +57,13 @@ Here is an example launch.json file to run the pubsub sample
{
"type": "node",
"request": "launch",
"name": "pub_sub",
"name": "mqtt5_x509",
"skipFiles": [
"<node_internals>/**"
],
"program": "${workspaceFolder}/samples/node/pub_sub/dist/index.js",
"program": "${workspaceFolder}/samples/node/mqtt/mqtt5_x509/dist/index.js",
"args": [
"--endpoint", "<account-number>-ats.iot.<region>.amazonaws.com",
"--ca_file", "<path to root-CA>",
"--cert", "<path to cert>",
"--key", "<path to key>",
"--client-id", "test-client"
Expand Down
285 changes: 0 additions & 285 deletions samples/node/pub_sub/README.md

This file was deleted.

Loading
Loading