forked from awslabs/aws-deployment-framework
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
**Why?** With the upcoming release of ADF, CDK v2 support is added. The dependencies that go with it, unfortunately increased the deployment size beyond the limit that is supported by the Serverless Application Repository. Hence a new installation mechanism had to be developed. **What?** This change proposes to use make as the deployment mechanism. I chose make, as this eases support queries on deployments of old version and future versions. For example, by default, the `make` command will install the latest `aws-sam-cli` and `yq` dependencies. However, if these appear to be incompatible, we can instruct to use a specific version of the make install script: ```bash make update_makefile make UPDATE_VERSION=make/2.0 update_makefile ``` Similarly, we can instruct using the AWS SAM CLI used at the time the ADF version was developed by running: ```bash make clean deps docker version_number git_ignore sam_build post_build ``` In case someone runs into an issue while building or deploying ADF, they can generate a report of their environment with: ```bash make version_report ``` This generates a report of all the versions of the build environment. _Long story short:_ The proposed Makefile enables various paths to resolve and investigate issues. **Changes** * Updated the Makefile to act as the new deployment mechanism. * Moved tox related tasks to test and lint the code to Makefile.tox. As these need to run in the virtual environment managed by Tox, not the one managed by the new Makefile. * Updated the docs to support ADF administrators updating and installing using the new Makefile. * Tested with v3.2.0 deployments and the upcoming release of ADF. * Added support to generate version numbers on customized ADF installations. * Updated the contribution docs to clarify how to deploy and test. * Added support to update the Makefile in the future, such that a deployment issue in a specific ADF version can be fixed by updating the Makefile. * Updated GitHub workflows accordingly, plus added new tests to ensure the dependencies installed by ADF are compatible with each other. * Added a new step in the GitHub workflow to test a full build of ADF. * Updated the Bug Issue template to include the version report and to allow the reporter to indicate that they are working on a fix already.
- Loading branch information
Showing
15 changed files
with
965 additions
and
299 deletions.
There are no files selected for viewing
This file contains 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
This file contains 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
This file contains 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
This file contains 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
Oops, something went wrong.