Skip to content

Commit

Permalink
docs: refer to ECR Public image (#4040)
Browse files Browse the repository at this point in the history
---

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

[Apache 2.0 license]: https://www.apache.org/licenses/LICENSE-2.0
  • Loading branch information
RomainMuller committed Apr 4, 2023
1 parent 0759ead commit f4ea4c5
Show file tree
Hide file tree
Showing 7 changed files with 20 additions and 20 deletions.
12 changes: 6 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -163,14 +163,14 @@ The [Python](./packages/jsii-pacmak/lib/targets/python.ts) target is a good
example to work from.

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

Upon merging new changes to the `main` branch, the `jsii/superchain:nightly`
image will be released by TravisCI after a last validation build.
Upon merging new changes to the `main` branch, the `public.ecr.aws/jsii/superchain:1-buster-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 `jsii/superchain:latest` image will
be released by TravisCI after a last validation build.
corresponding git tag - is created), the `public.ecr.aws/jsii/superchain:1-buster-slim` image will
be released after a last validation build.

The latest release information (for both of the Docker image tags) can be seen
on [Docker Hub](https://hub.docker.com/r/jsii/superchain/tags)
on [ECR Public Gallery](https://gallery.ecr.aws/jsii/superchain)
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
[![All Contributors](https://img.shields.io/github/all-contributors/aws/jsii/main?label=%E2%9C%A8%20All%20Contributors)](#contributors-)
[![Build Status](https://github.com/aws/jsii/workflows/Main/badge.svg)](https://github.com/aws/jsii/actions?query=workflow%3AMain+branch%3Amain)
[![npm](https://img.shields.io/npm/v/jsii?logo=npm)](https://www.npmjs.com/package/jsii)
[![docker](https://img.shields.io/badge/docker-jsii%2Fsuperchain-brightgreen?logo=docker)](https://hub.docker.com/r/jsii/superchain)
[![docker](https://img.shields.io/badge/Docker-public.ecr.aws%2Fjsii%2Fsuperchain-brightgreen?logo=docker)](https://gallery.ecr.aws/jsii/superchain)

## Overview

Expand Down
4 changes: 2 additions & 2 deletions gh-pages/content/specification/5-new-language-intake.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,13 +59,13 @@ code can be written. This component must be written in the new language.
Once code is generated and it has a _host_ runtime library to rely on, [`jsii-pacmak`] needs to receive the additional
logic required to compile and package the generated libraries as required, producing ready-to-publish artifacts.

The necessary toolchain needs to be added to the [`jsii/superchain`] _Docker_ image, so that `jsii` customers can rely
The necessary toolchain needs to be added to the [`public.ecr.aws/jsii/superchain`] _Docker_ image, so that `jsii` customers can rely
on this to build artifacts for any of the supported languages.

In addition to this, standardized _Amazon CodePipeline_ actions need to be developed in order to support publishing to
the relevant idiomatic package managers.

[`jsii/superchain`]: https://github.com/aws/jsii/tree/main/superchain
[`public.ecr.aws/jsii/superchain`]: https://github.com/aws/jsii/tree/main/superchain

## Compliance Tests

Expand Down
6 changes: 3 additions & 3 deletions gh-pages/content/user-guides/language-support/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,8 +105,8 @@ possible to publish artifacts even when tests in the suite are failing. As soon

## Building & Packaging

The necessary toolchains should be added to he [`jsii/superchain`] Docker image, so that the [`jsii-pacmak`] generation
can be changed to support building ready to publish artifacts instead of just code.
The necessary toolchains should be added to he [`public.ecr.aws/jsii/superchain`] Docker image, so that the
[`jsii-pacmak`] generation can be changed to support building ready to publish artifacts instead of just code.

Before publishing any artifacts, ensure all packages (the _host library_ as well as generated artifacts) are designated
as _experimental_ (e.g: **Python** packages were annotated with the `Development Status :: 4 - Beta` trove classifier on
Expand Down Expand Up @@ -165,7 +165,7 @@ declared _Generally Available_. At this point, breaking changes are no longer po
[`jsii-pacmak`]: ../../packages/jsii-pacmak
[`jsii-rosetta`]: ../../packages/jsii-rosetta
[standard compliance suite]: ../../specification/4-standard-compliance-suite.md
[`jsii/superchain`]: ../../superchain
[`public.ecr.aws/jsii/superchain`]: ../../superchain
[`aws-delivlib`]: https://github.com/awslabs/aws-delivlib
[aws cdk]: https://github.com/aws/aws-cdk
[semantic versioning]: https://semver.org
4 changes: 2 additions & 2 deletions superchain/Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ RUN echo "deb http://deb.debian.org/debian buster-backports main" > /etc/apt/sou
SHELL ["/bin/zsh", "-c"]

# Prepare maven binary distribution
ARG M2_VERSION="3.9.0"
ARG M2_VERSION="3.9.1"
ENV M2_DISTRO="https://www.apache.org/dist/maven/maven-3"
RUN set -eo pipefail \
&& curl -fSsL "${M2_DISTRO}/${M2_VERSION}/binaries/apache-maven-${M2_VERSION}-bin.tar.gz" \
Expand Down Expand Up @@ -250,7 +250,7 @@ COPY superchain /docker-source
# Create the attributions document
RUN RUST_DOCS="${RUSTUP_HOME}/toolchains/$(rustup show active-toolchain | cut -d' ' -f 1)/share/doc" \
&& RUSTUP_VERSION=$(rustup --version 2>/dev/null | cut -d' ' -f2) \
&& echo "This jsii/superchain image includes the following third-party software/licensing:" > /NOTICE \
&& echo "This public.ecr.aws/jsii/superchain image includes the following third-party software/licensing:" > /NOTICE \
&& echo "" >> /NOTICE \
# Start with the packages that didn't come from "apt-get" or don't have a copyright file
&& echo "################################################################################" >> /NOTICE \
Expand Down
10 changes: 5 additions & 5 deletions superchain/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
A [`debian:10-slim`][debian]-based Docker image bundling all the SDKs and tools
required in order to package [jsii] projects in all supported languages.

[debian]: https://hub.docker.com/_/debian
[debian]: https://gallery.ecr.aws/debian/debian
[jsii]: https://github.com/aws/jsii

## Included Language SDKs
Expand All @@ -23,7 +23,7 @@ SDK | Version
Maintained image tags are named using the following pattern:

```
jsii/superchain:<JSII-MAJOR>-<BASE>(-node<NODE-MAJOR>)(-nightly)
public.ecr.aws/jsii/superchain:<JSII-MAJOR>-<BASE>(-node<NODE-MAJOR>)(-nightly)
```

- `<JSII-MAJOR>` is the major line of the jsii toolchain
Expand Down Expand Up @@ -52,9 +52,9 @@ The previous image tags have been discontinued:

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

* `jsii/superchain:1-buster-slim-node14(-nightly)`
* `jsii/superchain:1-buster-slim-node16(-nightly)`
* `jsii/superchain:1-buster-slim-node18(-nightly)`
* `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)`

If you are building this image from source, you can control the Node version with the
`NODE_MAJOR_VERSION` build argument:
Expand Down
2 changes: 1 addition & 1 deletion superchain/build-local.sh
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,6 @@ docker build
--build-arg BUILD_TIMESTAMP=$(date -u +'%Y-%m-%dT%H:%M:%SZ') \
--build-arg REGISTRY="docker.io/library" \
--build-arg COMMIT_ID=${COMMIT_ID} \
-t "jsii/superchain:local" \
-t "public.ecr.aws/jsii/superchain:local" \
-f ${PWD}/Dockerfile \
..

0 comments on commit f4ea4c5

Please sign in to comment.