Skip to content

Commit

Permalink
Merge branch 'main' into mrgrain/feat/python3.8
Browse files Browse the repository at this point in the history
  • Loading branch information
mergify[bot] authored Nov 14, 2023
2 parents f6facd5 + 7197b4f commit bd2a86f
Show file tree
Hide file tree
Showing 6 changed files with 20 additions and 24 deletions.
3 changes: 1 addition & 2 deletions .github/workflows/docker-images.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,9 @@ jobs:
matrix:
debian:
- 'buster' # 10
- 'bullseye' # 11
node: ['18', '20']
include:
- debian: 'bullseye' # 11
node: '20'
- debian: 'bookworm' #12
node: '20'
env:
Expand Down
5 changes: 3 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -228,13 +228,14 @@ The [Python](./packages/jsii-pacmak/lib/targets/python.ts) target is a good
example to work from.

## Releasing

### The `public.ecr.aws/jsii/superchain` Docker image

Upon merging new changes to the `main` branch, the `public.ecr.aws/jsii/superchain:1-buster-slim-nightly`
Upon merging new changes to the `main` branch, the `public.ecr.aws/jsii/superchain:1-bullseye-slim-nightly`
image will be released after a last validation build.

Upon making a new `jsii` release (when the GitHub release entry - and its
corresponding git tag - is created), the `public.ecr.aws/jsii/superchain:1-buster-slim` image will
corresponding git tag - is created), the `public.ecr.aws/jsii/superchain:1-bullseye-slim` image will
be released after a last validation build.

The latest release information (for both of the Docker image tags) can be seen
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,14 @@ A *jsii module* can declare dependencies on any other *jsii module* by adding en
`package.json` file. Since most other platforms do not support multiple different versions of the same library to
coexist in the same closure, it is recommended to also declare all such dependencies as `peerDependencies`.

### non-jsii dependencies

Occasionally, a dependency on a *non-jsii module* is useful. Since such dependencies do not have generated bindings in
all the supported languages, they must be bundled with the *jsii module* that depends on them, by adding the library
into the `bundleDependencies` array in `package.json`. The API of the *jsii module* can not expose any type from bundled
dependencies, since those types would not be available in other languages.
into the `bundleDependencies` array in `package.json`.

The API of the *jsii module* can not expose any type from bundled dependencies, since those types would not be available in other languages.
TypeScript files that include a non-jsii dependency (e.g. a lambda handler for an AWS CDK Construct) cannot be exported from the `main`/`types` entry point.

!!! info
For more information on `package.json` file contents, refer to the [npm documentation][package-json].
Expand Down
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
mypy==1.4.1
pip==23.3 # required to use --config-settings
pip==23.3.1 # required to use --config-settings
20 changes: 6 additions & 14 deletions superchain/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,16 +38,10 @@ public.ecr.aws/jsii/superchain:<JSII-MAJOR>-<BASE>(-node<NODE-MAJOR>)(-nightly)

The previous image tags have been discontinued:

- `:latest` (users should migrate to `:1-buster-slim`)
- `:nightly` (users should migrate to `:1-buster-slim-nightly`)
- `:node10` (users should migrate to `:1-buster-slim-node18`)
- `:node10-nightly` (users should migrate to `:1-buster-slim-node18-nightly`)
- `:node12` (users should migrate to `:1-buster-slim-node18`)
- `:node12-nightly` (users shoudl migrate to `:1-buster-slim-node18-nightly`)
- `:node14` (users should migrate to `:1-buster-slim-node18`)
- `:node14-nightly` (users shoudl migrate to `:1-buster-slim-node18-nightly`)
- `:node16` (users should migrate to `:1-buster-slim-node18`)
- `:node16-nightly` (users shoudl migrate to `:1-buster-slim-node18-nightly`)
- `:latest` (users should migrate to `:1-bullseye-slim`)
- `:nightly` (users should migrate to `:1-bullseye-slim-nightly`)
- `:nodeX` (users should migrate to an image using a supported node version)
- `:nodeX-nightly` (users should migrate to a nightly image using a supported node version)

## Building

Expand All @@ -68,10 +62,8 @@ jsii$ docker build . -f superchain/Dockerfile -t jsii/superchain:local --target=

We build multiple versions of this image, for different versions of Node. They are available as:

* `public.ecr.aws/jsii/superchain:1-buster-slim-node14(-nightly)`
* `public.ecr.aws/jsii/superchain:1-buster-slim-node16(-nightly)`
* `public.ecr.aws/jsii/superchain:1-buster-slim-node18(-nightly)`
* `public.ecr.aws/jsii/superchain:1-buster-slim-node20(-nightly)`
* `public.ecr.aws/jsii/superchain:1-bullseye-slim-node18(-nightly)`
* `public.ecr.aws/jsii/superchain:1-bullseye-slim-node20(-nightly)`

If you are building this image from source, you can control the Node version with the
`NODE_MAJOR_VERSION` build argument:
Expand Down
6 changes: 3 additions & 3 deletions yarn.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit bd2a86f

Please sign in to comment.