SwiftPackageIndex helper package to upload and process documentation bundles.
Install the following AWS tools to be able to deploy:
brew install awscli brew tap aws/tap brew install aws-sam-cli
Deployment also requires Docker for Mac.
to set up the default credentials for deploying into AWS.
Subsequently, run either
make deploy-test or
make deploy-prod to deploy into the respective environment:
There is currently no automated test setup to validate a new release, because it would be quite complex to set up.
Instead, use the
dev environment to validate a new release as follows:
docker run --rm -v "$PWD":/host -w /host swift:5.8.0-amazonlinux2 swift test
dev-doc bundle from
spi-docs-inboxand uploading it to
aws s3 cp dev-swiftpackageindex-semanticversion-0.3.6-356386b9.zip s3://spi-scratch-inbox/
DocUploaderLambda-TestCloudWatch log group to confirm the new version has been triggered and processed the file without errors.
spi-dev-docsfor the given package (either by checking the timestamp or by deleting the version first and ensuring it re-appears).
Once a new release has been validated, push a new release as follows:
brew tap aws/tap brew install aws-sam-cli
brew upgrade aws-sam-cli