-
Notifications
You must be signed in to change notification settings - Fork 49
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
doc: Add GitHub issue template for releasing Conduit (#1947)
* add template * update release document * fix md linting
- Loading branch information
Showing
3 changed files
with
120 additions
and
63 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,109 @@ | ||
| name: Release Checklist | ||
| description: Use this template to guide you through the Conduit release process. | ||
| title: '[Release] Conduit vX.Y.Z' | ||
| labels: | ||
| - release | ||
| assignees: '' | ||
|
|
||
| body: | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| # Conduit Release Checklist | ||
| This issue serves as a checklist for releasing a new version of Conduit. Follow the steps below to ensure a smooth release process. | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| ## General Information | ||
| A Conduit release includes: | ||
| - A GitHub release with packages for different OS and architectures, checksums, a changelog, and source code. | ||
| - A GitHub package for the official Docker image, available on GitHub's Container Registry, tagged with `latest`. | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| ## Before a Release | ||
| ### Update Dependencies | ||
| Update dependencies in the following order, ensuring all repositories are cloned in the same directory: | ||
| - type: checkboxes | ||
| attributes: | ||
| label: Update Dependencies | ||
| options: | ||
| - label: 'conduit-commons: Run `scripts/get-compare-link.sh ../conduit-commons/` to compare the latest tag and `main` branch. If changes are needed, push a new tag.' | ||
| - label: 'conduit-connector-protocol: Update `conduit-commons` if necessary: `go get github.com/conduitio/conduit-commons@vX.Y.Z`. Run `scripts/get-compare-link.sh ../conduit-connector-protocol/` and tag if needed.' | ||
| - label: 'conduit-connector-sdk: Update dependencies (`conduit-commons`, `conduit-connector-protocol`) as needed. Run `scripts/get-compare-link.sh ../conduit-connector-sdk/` and tag if needed.' | ||
| - label: 'conduit-processor-sdk: Update `conduit-commons` if necessary. Run `scripts/get-compare-link.sh ../conduit-processor-sdk/` and tag if needed.' | ||
| - label: 'conduit-schema-registry: Update `conduit-commons` if necessary. Run `scripts/get-compare-link.sh ../conduit-schema-registry/` and tag if needed.' | ||
| - label: 'Connector SDK in conduit-connector-template: Bump the Connector SDK dependency.' | ||
| - label: 'Built-in connectors: Bump the Connector SDK: `scripts/bump-sdk-in-connectors.sh vX.Y.Z`. For each built-in connector (file, kafka, generator, s3, postgres, log), run `scripts/get-compare-link.sh ../conduit-processor-sdk/` and tag if needed.' | ||
| - label: 'Bump built-in connectors: Run `scripts/bump-builtin-connectors.sh`' | ||
| - label: 'Conduit: Update dependencies (`conduit-schema-registry`, `conduit-connector-sdk`, `conduit-processor-sdk`, `conduit-connector-protocol`, `conduit-commons`) if needed. Release Conduit (see instructions below).' | ||
|
|
||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| ## Documentation | ||
| - type: checkboxes | ||
| attributes: | ||
| label: Documentation | ||
| options: | ||
| - label: 'Write a blog post.' | ||
| - label: 'Regenerate processor documentation on [conduit-site](https://github.com/ConduitIO/conduit-site).' | ||
| - label: 'Update the banner on the website.' | ||
| - label: 'Search and replace the latest version in `conduit-site`.' | ||
| - label: 'Search and replace the latest version in [README.md](../README.md).' | ||
|
|
||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| ## Releasing Conduit | ||
| - type: checkboxes | ||
| attributes: | ||
| label: Releasing Conduit | ||
| options: | ||
| - label: 'Trigger a release by pushing a new tag starting with `v` (e.g., `v1.2.3`).' | ||
| - label: 'Use the script [scripts/tag.sh](https://github.com/ConduitIO/conduit/blob/main/scripts/tag.sh) to ensure version conformity.' | ||
|
|
||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| ```sh | ||
| scripts/tag.sh 1.2.3 | ||
| ``` | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| ## Nightly Builds | ||
| - Nightly builds (binaries and Docker images) are provided and kept for 7 days. | ||
| - The latest nightly Docker image is tagged with `latest-nightly`. | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| ## Implementation | ||
| - The GitHub release is created with [GoReleaser](https://github.com/goreleaser/goreleaser/). | ||
| - Nightly builds are triggered by a GitHub action, defined in [trigger-nightly.yml](/.github/workflows/trigger-nightly.yml). | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| ## Notes | ||
| - The "Trigger nightly build" GitHub action requires a personal access token, not the GitHub token provided by Actions. | ||
| For more information, refer to [Triggering a workflow from a workflow](https://docs.github.com/en/actions/using-workflows/triggering-a-workflow#triggering-a-workflow-from-a-workflow). | ||
| --- | ||
|
|
||
| Please ensure each step is completed before closing this issue. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters