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

deps: skuba 7.5.0 #229

Merged
merged 5 commits into from
Mar 13, 2024
Merged

deps: skuba 7.5.0 #229

merged 5 commits into from
Mar 13, 2024

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented Feb 7, 2024

Mend Renovate

This PR contains the following updates:

Package Change Age Adoption Passing Confidence
skuba 7.3.1 -> 7.5.0 age adoption passing confidence

Release Notes

seek-oss/skuba (skuba)

v7.5.0

Compare Source

Minor Changes
  • cli: Add 30-minute timeout to skuba commands in CI to avoid potential hanging builds. (#​1444)

    If there are use cases this breaks, please file an issue. A SKUBA_NO_TIMEOUT environment variable is supported on all commands to use the old behaviour. Timeout duration can be adjusted with a SKUBA_TIMEOUT_MS environment variable.

  • migrate: Introduce skuba migrate node20 to automatically upgrade a project's Node.js version (#​1382)

    skuba migrate node20 will attempt to automatically upgrade projects to Node.js 20. It will look in the project root for Dockerfiles, .nvmrc, and Serverless files, as well as CDK files in infra/ and .buildkite/ files, and try to upgrade them to a Node.js 20 version.

    skuba might not be able to upgrade all projects, so please check your project for any files that skuba missed. It's possible that skuba will modify a file incorrectly, in which case please open an issue.

    Node.js 20 comes with its own breaking changes, so please read the Node.js 20 release notes alongside the skuba release notes. In addition,

    • For AWS Lambda runtime updates to nodejs20.x, consider reading the release announcement as there are some breaking changes with this upgrade.
    • You may need to upgrade your versions of CDK and Serverless as appropriate to support nodejs20.x.
Patch Changes
  • lint: Remove Dockerfile-incunabulum rule (#​1441)

    Previously, skuba lint would search for and delete a file named Dockerfile-incunabulum to correct a historical issue that had it committed to source control. This rule has been removed as the file has been cleaned up from most SEEK repositories.

  • template/lambda-sqs-worker-cdk: Update tests to use a stable identifier for the AWS::Lambda::Version logical IDs in snapshots. This avoid snapshot changes on unrelated source code changes. (#​1450)

  • deps: picomatch ^4.0.0 (#​1442)

v7.4.1

Compare Source

Patch Changes
  • lint: Fix issue where skuba lint would fail in gutenberg projects due to the existence of Dockerfile-incunabulum files (#​1439)

v7.4.0

Compare Source

This version of skuba should not require significant upgrade effort for most projects, but it does contain some notable changes:

  • Internal linting and patching have been overhauled to streamline code generation on version upgrades.

    To make upgrades easy now and going forward, we recommend setting up GitHub autofixes.

  • New projects will now be initialised with pnpm, along with improved pnpm support.

    A future release of skuba may transition existing projects to pnpm.

Continue reading for more details on these changes and other improvements in this release.

Minor Changes
  • lint: Overhaul internal linting system (#​1370)

    Previously, internal lint rules would not fail a skuba lint check but would silently make changes to your working tree. These changes may have never been committed and may have caused subsequent noise when running skuba format or skuba lint.

    Now, internal linting is now promoted to a top-level tool alongside ESLint, Prettier, and tsc. Rules will report whether changes need to be made, and changes will only be applied in format or autofix modes (in CI). As a consequence, skuba lint may fail upon upgrading to this version if your project has internal lint violations that have been left unaddressed up to this point.

    You can configure skuba lint to automatically push autofixes; this eases adoption of linting rule changes and automatically resolves issues arising from a forgotten skuba format. You'll need to configure your CI environment to support this feature. See our GitHub autofixes documentation to learn more.

  • format: Switch Distroless image from nodejs-debian11 to nodejs-debian12 (#​1381)

  • deps: Prettier 3.2 (#​1384)

    See the release notes for more information.

  • init: Initialise new projects with pnpm (#​1289)

    New projects based on built-in templates will now use pnpm as their package manager as per updated organisational guidance.

    Custom templates will continue to default to Yarn 1.x until a future major version, though you can opt in to pnpm via skuba.template.js:

    module.exports = {
    + packageManager: 'pnpm',
    };
  • lint: Manage .npmrc for pnpm projects (#​1413)

    skuba now manages a section of .npmrc when a project uses pnpm to enable dependency hoisting. It will continue to avoid committing autofixes to the file if it contains auth secrets.

  • deps: TypeScript 5.3 (#​1324)

    This major release includes breaking changes. See the TypeScript 5.3 announcement for more information.

  • lint: Manage .dockerignore (#​1433)

    skuba now manages a section of .dockerignore for you, ensuring that the file is up to date with the latest enhancements in skuba.

  • init: Default to arm64 platform and main branch (#​1343)

  • init: Run Prettier after templating (#​1337)

  • init: Support main default branch (#​1335)

  • lint: Introduce skuba patches (#​1274)

    This feature adds patches which are run only once on the lint or format commands following a skuba update. If your build pipeline is utilising autofixes, these changes will be pushed up automatically.

Patch Changes
  • lint: Disable Promise<void> return checks in tests (#​1366)

    This works around an existing incompatibility between Koa and the built-in http.RequestListener type:

    const app = new Koa();
    
    const agent = supertest.agent(app.callback());
    //                            ~~~~~~~~~~~~~~
    // Promise returned in function argument where a void return was expected.
    // @&#8203;typescript-eslint/no-misused-promises
  • deps: picomatch ^3.0.0 (#​1309)

  • Jest: Export Config type (#​1360)

    This resolves a TypeScript error that could present itself when using Jest.mergePreset with the declaration compiler option:

    TS4082: Default export of the module has or is using private name ConfigGlobals.

  • template/lambda-sqs-worker: Remove @aws-sdk/util-utf8-node library (#​1326)

  • build, build-package, test: Remove empty export synthesis for Jest setup files (#​1274)

    isolatedModules was enabled by default in v5.0.0. To ease this migration, the commands listed above were updated to dynamically synthesise an empty export for jest.setup.ts and jest.setup.int.ts files; this compatibility logic has now been removed.

    Up-to-date projects are unlikely to be affected, but you can easily add an empty export statement to placate the TypeScript compiler:

    jest.setup.ts(1,1): error TS1208: 'jest.setup.ts' cannot be compiled under '--isolatedModules' because it is considered a global script file. Add an import, export, or an empty 'export {}' statement to make it a module.
    process.env.ENVIRONMENT = 'test';
    
    + export {};
  • template/lambda-sqs-worker-cdk: Switch to aws-cdk-lib/assertions (#​1372)

  • template/*-rest-api: Set readonlyRootFilesystem as a security best practice (#​1394)

  • template: Use propagate-environment for Docker Compose Buildkite plugin (#​1392)

    This simplifies the Docker Compose environment variable configuration required for Buildkite and GitHub integrations.

    In your docker-compose.yml:

    services:
      app:
    -   environment:
    -     # Enable Buildkite + GitHub integrations.
    -     - BUILDKITE
    -     - BUILDKITE_AGENT_ACCESS_TOKEN
    -     - BUILDKITE_BRANCH
    -     - BUILDKITE_BUILD_NUMBER
    -     - BUILDKITE_JOB_ID
    -     - BUILDKITE_PIPELINE_DEFAULT_BRANCH
    -     - BUILDKITE_STEP_ID
    -     - GITHUB_API_TOKEN
        image: ${BUILDKITE_PLUGIN_DOCKER_IMAGE:-''}
        init: true
        volumes:
          - ./:/workdir

Mount agent for Buildkite annotations.

    - /usr/bin/buildkite-agent:/usr/bin/buildkite-agent

Mount cached dependencies.

    - /workdir/node_modules

In your `.buildkite/pipeline.yml`:

```diff
steps:
  - commands:
      - pnpm lint
      - pnpm test
    env:

### At SEEK, this instructs the build agent to populate the GITHUB_API_TOKEN environment variable for this step.
      GET_GITHUB_TOKEN: 'please'
    plugins:
      - *aws-sm
      - *private-npm
      - *docker-ecr-cache
      - docker-compose#v4.16.0:
+         environment:
+           - GITHUB_API_TOKEN
+         propagate-environment: true
          run: app
  • template/*-rest-api: Disable dev CloudWatch dashboards for cost savings (#​1395)

  • template/lambda-sqs-worker-cdk: Add blue-green deployment, smoke test and version pruning functionality (#​1327)

  • template/lambda-sqs-worker*: Set maximum concurrency (#​1412)

    This prevents messages from going directly to the DLQ when the function reaches its reserved concurrency limit.

  • template/koa-rest-api: Improve input validation error response for Zod unions (#​1339)

  • template/lambda-sqs-worker-cdk: Introduce bundling with esbuild, --hotswap and --watch (#​1321)

    This template now uses the aws_lambda_nodejs.NodejsFunction construct which uses esbuild to bundle the Lambda function. This reduces cold start time and time to build on CI.

    The --hotswap and --watch options allow you to rapidly deploy your code changes to AWS, enhancing the developer feedback loop. This change introduces deploy:hotswap and deploy:watch scripts to the package.json manifest and a Deploy Dev (Hotswap) step to the Buildkite pipeline. Read more about watch and hotswap on the AWS Developer Tools Blog.


Configuration

📅 Schedule: Branch creation - "after 3:00 am and before 6:00 am every weekday" in timezone Australia/Melbourne, Automerge - At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

Rebasing: Whenever PR is behind base branch, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.


  • If you want to rebase/retry this PR, check this box

This PR has been generated by Mend Renovate. View repository job log here.

@renovate renovate bot changed the title deps: skuba 7.4.0 deps: skuba 7.4.1 Feb 8, 2024
@renovate renovate bot changed the title deps: skuba 7.4.1 deps: skuba 7.5.0 Feb 21, 2024
@renovate renovate bot requested a review from a team as a code owner March 12, 2024 22:05
Copy link
Contributor Author

renovate bot commented Mar 12, 2024

Edited/Blocked Notification

Renovate will not automatically rebase this PR, because it does not recognize the last commit author and assumes somebody else may have edited the PR.

You can manually request rebase by checking the rebase/retry box above.

Warning: custom changes will be lost.

@72636c 72636c merged commit cea6291 into master Mar 13, 2024
4 checks passed
@72636c 72636c deleted the renovate-skuba-7.x branch March 13, 2024 12:03
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.

2 participants