|
| 1 | +# Support model |
| 2 | + |
| 3 | +[`oapi-codegen`](https://github.com/oapi-codegen/oapi-codegen) is currently supported in a best-efforts means, due to the [Core Maintainers](https://github.com/oapi-codegen/governance/#core-maintainer) working in their "off hours" from their busy jobs. |
| 4 | + |
| 5 | +We do thoroughly appreciate our users, the feature requests and bug reports raised, and want to set expectations accordingly. |
| 6 | + |
| 7 | +Related: |
| 8 | + |
| 9 | +- [Creating a more sustainable model for `oapi-codegen` in the future](https://github.com/oapi-codegen/oapi-codegen/discussions/1606) |
| 10 | +- [Looking back at `oapi-codegen`'s last year](https://github.com/oapi-codegen/oapi-codegen/discussions/1985) |
| 11 | + |
| 12 | +## Supported versions |
| 13 | + |
| 14 | +Only the latest minor release version of `oapi-codegen` is supported for active development. |
| 15 | + |
| 16 | +`oapi-codegen` does not currently backport any bug fixes. |
| 17 | + |
| 18 | +## Security updates |
| 19 | + |
| 20 | +Related: [`oapi-codegen`'s organisational security policy (`SECURITY.md`)](https://github.com/oapi-codegen/.github/blob/HEAD/SECURITY.md). |
| 21 | + |
| 22 | +## Minimum required Go toolchain version |
| 23 | + |
| 24 | +As per [the install instructions](https://github.com/oapi-codegen/oapi-codegen/#install), `oapi-codegen`'s recommended installation model is as a source-tracked dependency, for instance using `go tool`. |
| 25 | + |
| 26 | +Because of this, we take more care to resist bumping the `go` directive, as it has a knock-on effect for all consumers of `oapi-codegen`, as it requires the consumer to _also_ bump their `go` directive. |
| 27 | + |
| 28 | +When considering whether to bump the `go` directive, we will consider: |
| 29 | + |
| 30 | +- Do we _definitely_ need to pull in this new version of Go? |
| 31 | + - Can we work around it by not using new language features? |
| 32 | +- If this is a requirement of an upstream dependency, can upstream use build tags ([like so](https://github.com/charmbracelet/log/pull/13)), to allow us to continue using old versions of Go? |
| 33 | + - If it is a requirement, and we don't want to bump it (yet), can we avoid the Go version bump? |
| 34 | +- Is the new version supported by the Go team? |
| 35 | + - We're comfortable not requiring the Go version being in active support - it's up to consumers to decide what toolchain + standard library version they want to use to build |
| 36 | + |
| 37 | +We will not mandate a `toolchain` directive. |
| 38 | + |
| 39 | +## Additional support |
| 40 | + |
| 41 | +For additional support, it's worth reading [oapi-codegen/governance: Sponsorship](https://github.com/oapi-codegen/governance/#sponsorship), and visiting the different [funding options](https://github.com/oapi-codegen/oapi-codegen/blob/main/.github/FUNDING.yml). |
0 commit comments