From f69a4ad2208ec84d475c376066f9c73af780d8b8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Kat=20March=C3=A1n?= Date: Fri, 31 Jul 2026 15:06:19 -0700 Subject: [PATCH] docs: add dev guide and make releases go live immediately --- .github/workflows/release.yml | 2 -- DEVELOPMENT.md | 23 +++++++++++++++++++++++ 2 files changed, 23 insertions(+), 2 deletions(-) create mode 100644 DEVELOPMENT.md diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 33fe649..2504b68 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -117,5 +117,3 @@ jobs: artifactErrorsFailBuild: true artifactContentType: "application/gzip" generateReleaseNotes: true - draft: true - prerelease: true diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md new file mode 100644 index 0000000..e8554c4 --- /dev/null +++ b/DEVELOPMENT.md @@ -0,0 +1,23 @@ +# Developer's Guide + +This document includes notes for devs of the SDK itself. This is largely for +things involving releases, architecture, etc. See +[CONTRIBUTING.md](./CONTRIBUTING.md) for docs meant for contributors to get up +and running enough to send in pull requests. + +## Releasing + +We use [this workflow](./.github/workflows/release.yml) to mostly automate +releases. New releases are a three-step process: + +1. Go to [the list of closed + PRs](https://github.com/fastly/compute-sdk-cpp/pulls?q=is%3Apr%20is%3Aclosed) + and make sure they all have appropriate labels—the release system will use + this to generate changelogs. To see what labels map to what, refer to the + [Release Action config](./.github/release.yml). +1. Locally, tag a new release, following semver conventions, prefixed with a `v` + (so, `v1.2.3`). Push the tag. + +From here, just wait for the [release +action](https://github.com/fastly/compute-sdk-cpp/actions/workflows/release.yml) +to complete, and you'll have a live release! \ No newline at end of file