Skip to content

Commit

Permalink
Adding disclaimer for GO versioning support (#955)
Browse files Browse the repository at this point in the history
* Adding disclaimer for GO versioning support

* Update README.md

Co-authored-by: Michael Dawson <[email protected]>

---------

Co-authored-by: Michael Dawson <[email protected]>
  • Loading branch information
pacostas and mhdawson authored Sep 25, 2024
1 parent 4fa87a7 commit 9137967
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

The Node.js Paketo Buildpack provides a set of collaborating buildpacks that
enable the building of a Node.js-based application. These buildpacks include:

- [Node Engine CNB](https://github.com/paketo-buildpacks/node-engine)
- [Yarn CNB](https://github.com/paketo-buildpacks/yarn)
- [Yarn Install CNB](https://github.com/paketo-buildpacks/yarn-install)
Expand All @@ -21,12 +22,14 @@ Usage examples can be found in the
[`samples` repository under the `nodejs` directory](https://github.com/paketo-buildpacks/samples/tree/main/nodejs).

#### The Node.js buildpack is compatible with the following builder(s):

- [Paketo Jammy Full Builder](https://github.com/paketo-buildpacks/builder-jammy-full)
- [Paketo Jammy Base Builder](https://github.com/paketo-buildpacks/builder-jammy-base)
- [Paketo Full Builder](https://github.com/paketo-buildpacks/full-builder)
- [Paketo Base Builder](https://github.com/paketo-buildpacks/base-builder) (for apps which do not leverage common C libraries)

This buildpack also includes the following utility buildpacks:

- [Procfile CNB](https://github.com/paketo-buildpacks/procfile)
- [Environment Variables CNB](https://github.com/paketo-buildpacks/environment-variables)
- [Image Labels CNB](https://github.com/paketo-buildpacks/image-labels)
Expand All @@ -35,3 +38,9 @@ This buildpack also includes the following utility buildpacks:
- [Node Module Bill of Materials CNB](https://github.com/paketo-buildpacks/node-module-bom)

Check out the [Paketo Node.js docs](https://paketo.io/docs/buildpacks/language-family-buildpacks/nodejs/) for more information.

## Maintenance

### Go Module Versioning

Each buildpack is a Go module, and in the case of the Node.js buildpacks, we only maintain and support the latest versions, without providing support for any **previous** `major` or `minor` versions. **Further the team does not currently commit to maintain the go major versions to in sync with the Semver versions used to publish releases. Keeping the go major versions up to date with the versions used to publish the buildpacks and consumed in the buildpack tomls is addhoc and based PRs being sumitted by the community**.

0 comments on commit 9137967

Please sign in to comment.