Skip to content
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

chore: housekeeping and cleanup - gitignore, package.json #570

Merged
merged 2 commits into from
Nov 23, 2021

Conversation

njlynch
Copy link
Contributor

@njlynch njlynch commented Nov 23, 2021

A few minor housekeeping chores to make the repo slightly easier to work
with. First, standardizing on having the language-specific .gitignore files in
the top-level language directory, rather than (inconsistently) repeated in each
sample. There are a few exceptions where a local .gitignore is used, but it's
the exception now rather than the rule.

Also, the build scripts for csharp and go currently do an npm install command
as part of the script, but there was no package.json in those
directories. With older versions of Node (e.g., 12), this fails but doesn't exit
with a non-zero status; on newer versions, this causes the whole build to fail.

Lastly, a lot of the Typescript samples didn't list aws-cdk as either a
dependency or devDependency, relying on the globally-installed CDK version. Fine
on our build machines, but can cause problems in local development, especially if a
recent release changes the cloud assembly schema version.


By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

A few minor housekeeping chores to make the repo slightly easier to work
with. First, standardizing on having the language-specific `.gitignore` files in
the top-level language directory, rather than (inconsistently) repeated in each
sample. There are a few exceptions where a local `.gitignore` is used, but it's
the exception now rather than the rule.

Also, the build scripts for csharp and go currently do an `npm install` command
as part of the script, but there was no `package.json` in those
directories. With older versions of Node (e.g., 12), this fails but doesn't exit
with a non-zero status; on newer versions, this causes the whole build to fail.

Lastly, a lot of the Typescript samples didn't list `aws-cdk` as either a
dependency or devDependency, relying on the globally-installed CDK version. Fine
on our build machines, but can cause problems in local development, especially if a
recent release changes the cloud assembly schema version.
@njlynch njlynch requested a review from a team November 23, 2021 17:16
@njlynch njlynch self-assigned this Nov 23, 2021
otaviomacedo
otaviomacedo previously approved these changes Nov 23, 2021
@njlynch njlynch enabled auto-merge (squash) November 23, 2021 17:25
@mergify mergify bot dismissed otaviomacedo’s stale review November 23, 2021 17:25

Pull request has been modified.

@njlynch njlynch merged commit b3acc9b into master Nov 23, 2021
@njlynch njlynch deleted the njlynch/cleanup branch November 23, 2021 17:43
its-mirus-lu pushed a commit to its-mirus-lu/aws-cdk-examples that referenced this pull request Mar 26, 2022
…s#570)

A few minor housekeeping chores to make the repo slightly easier to work
with. First, standardizing on having the language-specific `.gitignore` files in
the top-level language directory, rather than (inconsistently) repeated in each
sample. There are a few exceptions where a local `.gitignore` is used, but it's
the exception now rather than the rule.

Also, the build scripts for csharp and go currently do an `npm install` command
as part of the script, but there was no `package.json` in those
directories. With older versions of Node (e.g., 12), this fails but doesn't exit
with a non-zero status; on newer versions, this causes the whole build to fail.

Lastly, a lot of the Typescript samples didn't list `aws-cdk` as either a
dependency or devDependency, relying on the globally-installed CDK version. Fine
on our build machines, but can cause problems in local development, especially if a
recent release changes the cloud assembly schema version.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants