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(NODE-6578): add misc tooling to ZSTD repo #36

Open
wants to merge 9 commits into
base: main
Choose a base branch
from

Conversation

baileympearson
Copy link
Contributor

@baileympearson baileympearson commented Nov 21, 2024

Description

What is changing?

This PR contains a smattering of tooling we'll need for the SSDLC release flow (coming in the next PR):

  • A release please config and manifest has been added.
  • A new build action has been added, that builds the bindings and uploads the to GHA artifact storage (for use in the release action later, coming in a follow-up PR)
  • CodeQL has been enabled and configured for both C++ and JS.
  • A new SBOM file has been generated, which includes the correct version of zstd as our only bundled dependency.
  • The zstd C library version now is specified in the package.json and the install scripts reads the package file to install the correct version of zstd.
Is there new documentation needed for these changes?

What is the motivation for this change?

Double check the following

  • Ran npm run format:js && npm run format:rs script
  • Self-review completed using the steps outlined here
  • PR title follows the correct format: type(NODE-xxxx)[!]: description
    • Example: feat(NODE-1234)!: rewriting everything in coffeescript
  • Changes are covered by tests
  • New TODOs have a related JIRA ticket

@github-advanced-security
Copy link

This pull request sets up GitHub code scanning for this repository. Once the scans have completed and the checks have passed, the analysis results for this pull request branch will appear on this overview. Once you merge this pull request, the 'Security' tab will show more code scanning analysis results (for example, for the default branch). Depending on your configuration and choice of analysis tool, future pull requests will be annotated with code scanning analysis results. For more information about GitHub code scanning, check out the documentation.

@baileympearson baileympearson changed the title add codeql chore(NODE-6578): add misc tooling to ZSTD repo Nov 22, 2024
@baileympearson baileympearson marked this pull request as ready for review November 22, 2024 20:55
@aditi-khare-mongoDB aditi-khare-mongoDB self-assigned this Nov 22, 2024
@aditi-khare-mongoDB aditi-khare-mongoDB added the Primary Review In Review with primary reviewer, not yet ready for team's eyes label Nov 22, 2024
analyze:
name: Analyze (${{ matrix.language }})
runs-on: "ubuntu-latest"
timeout-minutes: 360
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

CodeQL only takes about 2 minutes, is there a reason we put a timeout here and chose 360?

@@ -2,13 +2,19 @@
ARG PLATFORM=arm64
ARG NODE_VERSION=16.20.1

FROM ${PLATFORM}/node:${NODE_VERSION}-alpine AS node
FROM ${PLATFORM}/node:${NODE_VERSION}-alpine AS build
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What's the motivation behind this change?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Primary Review In Review with primary reviewer, not yet ready for team's eyes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants