Skip to content

Commit

Permalink
chore: remove EOS packages jsii and jsii-rosetta (#4701)
Browse files Browse the repository at this point in the history
Delete the 1.x version line of these packages.

Please use [aws/jsii-compiler](https://github.com/aws/jsii-compiler) and
[aws/jsii-rosetta](https://github.com/aws/jsii-rosetta) respectively.

---

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
mrgrain authored Nov 15, 2024
1 parent 1892a7e commit 4f930f6
Show file tree
Hide file tree
Showing 719 changed files with 447 additions and 40,393 deletions.
69 changes: 6 additions & 63 deletions .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -376,67 +376,14 @@ jobs:
# This is just a join target to simplify branch protection setup
run: echo OK

benchmark:
name: Run benchmark suite
runs-on: ubuntu-latest
permissions:
contents: read
pull-requests: write
needs: build
steps:
# Check out the code
- name: Download Artifact
uses: actions/download-artifact@v3
with:
name: built-tree
- name: Extract Artifact
run: |-
echo "::group::Untar Archive"
tar zxvf built-tree.tgz
echo "::endgroup"
rm built-tree.tgz
- name: Set up Node
uses: actions/setup-node@v4
with:
cache: yarn
node-version: 'lts/*'
- name: Install Dependencies
run: yarn install --frozen-lockfile
- name: Run Benchmark
working-directory: packages/@jsii/benchmarks
run: yarn bench --output ${{ runner.temp }}/bench-output.json
- name: Compare Benchmark Results
if: github.event_name == 'pull_request'
uses: benchmark-action/github-action-benchmark@v1
with:
name: jsii Benchmark Regression
tool: 'customSmallerIsBetter'
output-file-path: ${{ runner.temp }}/bench-output.json
comment-always: true
github-token: ${{ secrets.GITHUB_TOKEN }}
fail-on-alert: true
- name: Upload Benchmark Results
if: github.event_name == 'push'
uses: benchmark-action/github-action-benchmark@v1
with:
name: jsii Benchmark
tool: 'customSmallerIsBetter'
output-file-path: ${{ runner.temp }}/bench-output.json
github-token: ${{ secrets.PROJEN_GITHUB_TOKEN }}
auto-push: true

pacmak-integration-test:
runs-on: ubuntu-latest
needs: create-release-package
strategy:
fail-fast: false
matrix:
rosetta:
# this will be the 1.x-dev version build in this repo
- ./jsii-rosetta.tgz
- 5.2.x
- 5.3.x
- latest
- 5.4.x
- 5.5.x
- 5.6.x
Expand Down Expand Up @@ -473,15 +420,11 @@ jobs:
run: sudo apt install -y python3-venv
# Show time!
- name: Prepare Work Tree
# 1) Move the locally build version of jsii-rosetta somewhere else
# 2) Remove @jsii/integ-test because it messed up version dependencies and is not needed
# 3) Install aws-cdk-lib, and all locally build packages minus jsii-rosetta & @jsii/integ-test,
# and the specific version of jsii-rosetta
# This ensures we are running jsii-pacmak with the correct peer-dependency
# 4) Print the jsii-rosetta version for confirmation
# 1) Install aws-cdk-lib,
# all locally build packages,
# the specific version of jsii-rosetta.
# 2) Print the jsii-rosetta version for confirmation
run: |-
mv ${{ runner.temp }}/release-package/js/jsii-rosetta.tgz ./jsii-rosetta.tgz
rm ${{ runner.temp }}/release-package/private/@jsii-integ-test.tgz
npm install --no-save --omit=dev \
aws-cdk-lib@2 \
constructs@10 \
Expand All @@ -498,7 +441,7 @@ jobs:
./node_modules/.bin/jsii-pacmak --no-parallel ./node_modules/aws-cdk-lib
# Upload artifact only on main and for latest rosetta
- name: 'Upload Artifact: integtest_aws-cdk-lib'
if: github.ref == 'ref/head/main' && matrix.rosetta == '5.4.x'
if: github.ref == 'ref/head/main' && matrix.rosetta == 'latest'
uses: actions/upload-artifact@v4
with:
name: integtest_aws-cdk-lib
Expand Down
3 changes: 2 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ Each one of these scripts can be executed either from the root of the repo using
Troubleshooting bugs usually starts with adding a new test that demonstrates the
faulty behavior, then modifying implementations until the test passes.

The `jsii-calc` and `@scope/*` packages are used to test expected brhavior from
The `jsii-calc` and `@scope/*` packages are used to test expected behavior from
the compiler (note that the [aws/jsii-compiler](github.com/aws/jsii-compiler)
repository as a separate copy of these under the `fixtures` directory), as well
as downstream tooling (`jsii-pacmak`, `jsii-rosetta`, etc...). Each language
Expand Down Expand Up @@ -276,3 +276,4 @@ To ensure compatibility, we also have integration tests.

1. Add the new version to the `jsii-rosetta` peer dependency in [package.json](./packages/jsii-pacmak/package.json)
2. Add the new version to the `pacmak-integration-test` matrix in the main build workflow in [main.yml](.github/workflows/main.yml)
3. Remove any versions for which support has ended (EOS) from both locations
22 changes: 10 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,27 +21,25 @@ usual), but also in **Python**, **Java**, **C#** (and other languages from the _
Head over to our [documentation website](https://aws.github.io/jsii)!

The jsii toolchain is spread out on multiple repositories:
- [aws/jsii-compiler](https://github.com/aws/jsii-compiler) is where the `jsii` compiler is maintained (except releases
in the `1.x` line, which are maintained in this repository)

- [aws/jsii-compiler](https://github.com/aws/jsii-compiler) is where the `jsii` compiler is maintained
- [aws/jsii-rosetta](https://github.com/aws/jsii-rosetta) is where the `jsii-rosetta` sample code transliteration tool
is maintained (except releases in the `1.x` line, which are maintained in this repository)
is maintained
- [aws/jsii](https://github.com/aws/jsii) is where the rest of the toolchain is maintained, including:
- `@jsii/spec`, the package that defines the *`.jsii` assembly* specification
- `jsii-config`, an interactive tool to help configure your jsii package
- `jsii-pacmak`, the bindings generator for jsii packages
- `jsii-reflect`, a higher-level way to process *`.jsii` assemblies*
- The jsii runtime libraries for the supported jsii target languages
- `1.x` release lines of `jsii` and `jsii-rosetta`
- `@jsii/spec`, the package that defines the _`.jsii` assembly_ specification
- `jsii-pacmak`, the bindings generator for jsii packages
- `jsii-reflect`, a higher-level way to process _`.jsii` assemblies_
- `jsii-config`, an interactive tool to help configure your jsii package

# :book: Blog Posts
## :book: Blog Posts

Here's a collection of blog posts (in chronological order) related to `jsii`:

- **2020-01-11:** <a id="blog-mbonig" /> [How to Create CDK Constructs][mbonig-2020-01-11], by [Matthew Bonig][@mbonig]
- **2020-05-27:** <a id="blog-floydpink" /> [Generate Python, Java, and .NET software libraries from a TypeScript
source][floydpink-2020-05-27], by [Hari Pachuveetil][@floydpink]
- **2020-12-23:** <a id="blog-romainmuller" /> [How the jsii open source framework meets developers where they are
][romain-2020-12-23], by [Romain Marcadier][@RomainMuller]
- **2020-12-23:** <a id="blog-romainmuller" /> [How the jsii open source framework meets developers where they are][romain-2020-12-23], by [Romain Marcadier][@RomainMuller]

[mbonig-2020-01-11]: https://www.matthewbonig.com/2020/01/11/creating-constructs/
[floydpink-2020-05-27]:
Expand All @@ -55,7 +53,7 @@ Here's a collection of blog posts (in chronological order) related to `jsii`:
> :information_source: If you wrote blog posts about `jsii` and would like to have them referenced here, do not hesitate
> to file a pull request to add the links here!
# :gear: Contributing
## :gear: Contributing

See [CONTRIBUTING](./CONTRIBUTING.md).

Expand Down
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -17,15 +17,15 @@
"devDependencies": {
"@jest/types": "^29.6.3",
"@types/jest": "^29.5.14",
"@types/node": "^14.18.63",
"@types/node": "^18",
"@typescript-eslint/eslint-plugin": "^8.14.0",
"@typescript-eslint/parser": "^8.14.0",
"all-contributors-cli": "^6.26.1",
"eslint": "^9.14.0",
"eslint-config-prettier": "^9.1.0",
"eslint-import-resolver-node": "^0.3.9",
"eslint-import-resolver-typescript": "^3.6.3",
"eslint-plugin-import": "2.26.0",
"eslint-plugin-import": "2.31.0",
"eslint-plugin-prettier": "^5.2.1",
"jest": "^29.7.0",
"jest-circus": "^28.1.3",
Expand Down
9 changes: 0 additions & 9 deletions packages/@jsii/benchmarks/.eslintrc.yaml

This file was deleted.

4 changes: 0 additions & 4 deletions packages/@jsii/benchmarks/.gitignore

This file was deleted.

25 changes: 0 additions & 25 deletions packages/@jsii/benchmarks/README.md

This file was deleted.

138 changes: 0 additions & 138 deletions packages/@jsii/benchmarks/bin/benchmark.ts

This file was deleted.

Binary file not shown.
Loading

0 comments on commit 4f930f6

Please sign in to comment.