Add CI to validate required files (#665)

* add file validation

* remove basic pubsub

* remove exec.mainClass

* rename link file

* add more docs

Author: xiazhvera

.github/workflows/aws-service-sanity-check.yml

@@ -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/ci-aws-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

documents/FAQ.md

@@ -16,7 +16,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-java-v2#installation) and then build and run the [basic PubSub](https://github.com/aws/aws-iot-device-sdk-java-v2/tree/main/samples#pubsub)
+If you are just getting started make sure you [install this sdk](https://github.com/aws/aws-iot-device-sdk-java-v2#installation) and then build and run the [Mqtt5 X509 Sample](https://github.com/aws/aws-iot-device-sdk-java-v2/tree/main/samples/Mqtt/Mqtt5X509)
 
 ### How do I enable logging?
 
@@ -34,7 +34,7 @@ To enable logging in the samples, you will need to set the following system prop
 * `aws.crt.log.level`: The level of logging shown. Can be `Trace`, `Debug`, `Info`, `Warn`, `Error`, `Fatal`, or `None`. Defaults to `Warn`.
 * `aws.crt.log.filename`: The path to save the log file. Only needed if `aws.crt.log.destination` is set to `File`.
 
-For example, to run `BasicPubSub` with logging you could use the following:
+For example, to run `Mqtt X509` with logging you could use the following:
 
 ```sh
 mvn compile exec:java -pl samples/Mqtt/Mqtt5X509 -Daws.crt.debugnative=true -Daws.crt.log.level=Debug -Daws.crt.log.destination=Stdout -Dexec.args='--endpoint <endpoint> --cert <path to cert> --key <path to key>'

documents/MIGRATION_GUIDE.md

@@ -905,8 +905,8 @@ samples.
 ### Example
 
 It's always helpful to look at a working example to see how new functionality works, to be able to tweak different options,
-to compare with existing code. For that reason, we implemented a [Publish/Subscribe example](https://github.com/aws/aws-iot-device-sdk-java-v2/tree/main/samples/Mqtt5/PubSub)
-([source code](https://github.com/aws/aws-iot-device-sdk-java-v2/blob/main/samples/Mqtt5/PubSub/src/main/java/pubsub/PubSub.java))
+to compare with existing code. For that reason, we implemented a [Publish/Subscribe example](https://github.com/aws/aws-iot-device-sdk-java-v2/tree/main/samples/Mqtt/Mqtt5X509)
+([source code](https://github.com/aws/aws-iot-device-sdk-java-v2/blob/main/samples/Mqtt/Mqtt5X509/src/main/java/mqtt5x509/Mqtt5X509.java))
 in the V2 SDK similar to a sample provided by V1 SDK (see a corresponding [readme section](https://github.com/aws/aws-iot-device-sdk-java/tree/master?tab=readme-ov-file#sample-applications)
 and [source code](https://github.com/aws/aws-iot-device-sdk-java/blob/master/aws-iot-device-sdk-java-samples/src/main/java/com/amazonaws/services/iot/client/sample/pubSub/PublishSubscribeSample.java)).
 

pom.xml

@@ -8,7 +8,6 @@
 
     <modules>
         <module>sdk</module>
-        <module>samples/BasicPubSub</module>
         <module>samples/Mqtt/Mqtt5X509</module>
         <module>samples/Mqtt/Mqtt5AwsWebsocket</module>
         <module>samples/Mqtt/Mqtt5CustomAuthSigned</module>