- Notifications
You must be signed in to change notification settings - Fork 220
Add CI to validate required files #661
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
xiazhvera wants to merge 17 commits into main Choose a base branch from doc_link_validation
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline, and old review comments may become outdated.
+39 −266
Open
Changes from all commits
Commits
Show all changes
17 commits Select commit Hold shift + click to select a range
26a7171
update the ci to validate the necessary file links
xiazhvera 9eabcb0
eof
xiazhvera b0351ba
fix doc links ci
xiazhvera 8d55df6
improve script to handle file list
xiazhvera f8cf657
udpate instructions
xiazhvera 33b778b
handle file list
xiazhvera f1d3ea3
remove gg doc for now
xiazhvera 3e81b89
Merge branch 'main' into doc_link_validation
xiazhvera a32134f
Potential fix for code scanning alert no. 16: Workflow does not conta…
xiazhvera d76f154
remove old pubsub sample
xiazhvera 569ed8a
Merge branch 'doc_link_validation' of https://github.com/aws/aws-iot-…
xiazhvera f5b1320
Merge branch 'main' into doc_link_validation
xiazhvera bfe878e
Merge branch 'main' of https://github.com/aws/aws-iot-device-sdk-pyth…
xiazhvera 38d71d0
add back main readme
xiazhvera c12a550
revert sample read me
xiazhvera 98236ee
rename the script file
xiazhvera c165a3c
rename the file
xiazhvera File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
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/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 |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
samples/mqtt/mqtt5_x509.py | ||
Add this suggestion to a batch that can be applied as a single commit. This suggestion is invalid because no changes were made to the code. Suggestions cannot be applied while the pull request is closed. Suggestions cannot be applied while viewing a subset of changes. Only one suggestion per line can be applied in a batch. Add this suggestion to a batch that can be applied as a single commit. Applying suggestions on deleted lines is not supported. You must change the existing code in this line in order to create a valid suggestion. Outdated suggestions cannot be applied. This suggestion has been applied or marked resolved. Suggestions cannot be applied from pending reviews. Suggestions cannot be applied on multi-line comments. Suggestions cannot be applied while the pull request is queued to merge. Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let's add a short description to what this file is in case someone finds it here. It'd also be nice if we can add the cross-link to the AWS page/script/whatever that's accessing the listed file in case we expand this later to include things like greengrass etc...