Skip to content

Commit 5266985

Browse files
raulbraulb
authored
chore: update issue for the release template (#2132)
* chore: update issue for the release template This came up during yesterday's retrospective. * bring back label * release template to markdown * push updates * fix * fix line length * fix * fix IIIII
1 parent 7f54a6c commit 5266985

File tree

2 files changed

+113
-115
lines changed

2 files changed

+113
-115
lines changed

Diff for: ‎.github/ISSUE_TEMPLATE/4-conduit-release.md

+113
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,113 @@
1+
---
2+
name: 🚢 Conduit release checklist
3+
about: Use this template to guide you through the Conduit release process.
4+
title: "[Release] Conduit vX.Y.Z"
5+
labels: release
6+
assignees: ''
7+
---
8+
9+
This issue serves as a checklist for releasing a new version of Conduit.
10+
Follow the steps below to ensure a smooth release process.
11+
12+
## General Information
13+
14+
A Conduit release includes:
15+
16+
- A GitHub release with packages for different OS and architectures, checksums,
17+
a changelog, and source code.
18+
- A GitHub package for the official Docker image, available on GitHub's Container
19+
Registry, tagged with `latest`.
20+
21+
## Before a Release
22+
23+
### Update Dependencies
24+
25+
Update dependencies in the following order, ensuring all repositories are cloned in the same directory:
26+
27+
- [ ] **[`conduit-commons`](https://github.com/ConduitIO/conduit-commons)**:
28+
Run `scripts/get-compare-link.sh ../conduit-commons/` to compare the latest tag and `main` branch.
29+
If changes are needed, push a new tag.
30+
- [ ] **[`conduit-connector-protocol`](https://github.com/ConduitIO/conduit-connector-protocol)**:
31+
Update `conduit-commons` if necessary: `go get github.com/conduitio/[email protected]`.
32+
Run `scripts/get-compare-link.sh ../conduit-connector-protocol/` and tag if needed.
33+
- [ ] **[`conduit-connector-sdk`](https://github.com/ConduitIO/conduit-connector-sdk)**:
34+
Update dependencies (`conduit-commons`, `conduit-connector-protocol`) as needed.
35+
Run `scripts/get-compare-link.sh ../conduit-connector-sdk/` and tag if needed.
36+
- [ ] **[`conduit-processor-sdk`](https://github.com/ConduitIO/conduit-processor-sdk)**:
37+
Update `conduit-commons` if necessary. Run `scripts/get-compare-link.sh ../conduit-processor-sdk/`
38+
and tag if needed.
39+
- [ ] **[`conduit-schema-registry`](https://github.com/ConduitIO/conduit-schema-registry)**:
40+
Update `conduit-commons` if necessary. Run `scripts/get-compare-link.sh ../conduit-schema-registry/`
41+
and tag if needed.
42+
- [ ] **[Connector SDK in `conduit-connector-template`](https://github.com/ConduitIO/conduit-connector-template)**:
43+
Bump the Connector SDK dependency.
44+
- [ ] **[`conduit-connector-file`](https://github.com/ConduitIO/conduit-connector-file)**:
45+
Bump the Connector SDK `scripts/bump-sdk-in-connectors.sh vX.Y.Z`.
46+
Run `scripts/get-compare-link.sh ../conduit-connector-file/` and tag if needed.
47+
- [ ] **[`conduit-connector-kafka`](https://github.com/ConduitIO/conduit-connector-kafka)**:
48+
Bump the Connector SDK `scripts/bump-sdk-in-connectors.sh vX.Y.Z`.
49+
Run `scripts/get-compare-link.sh ../conduit-connector-kafka/` and tag if needed.
50+
- [ ] **[`conduit-connector-generator`](https://github.com/ConduitIO/conduit-connector-generator)**:
51+
Bump the Connector SDK `scripts/bump-sdk-in-connectors.sh vX.Y.Z`.
52+
Run `scripts/get-compare-link.sh ../conduit-connector-generator/` and tag if needed.
53+
- [ ] **[`conduit-connector-s3`](https://github.com/ConduitIO/conduit-connector-s3)**:
54+
Bump the Connector SDK `scripts/bump-sdk-in-connectors.sh vX.Y.Z`.
55+
Run `scripts/get-compare-link.sh ../conduit-connector-s3/` and tag if needed.
56+
- [ ] **[`conduit-connector-postgres`](https://github.com/ConduitIO/conduit-connector-postgres)**:
57+
Bump the Connector SDK `scripts/bump-sdk-in-connectors.sh vX.Y.Z`.
58+
Run `scripts/get-compare-link.sh ../conduit-connector-postgres/` and tag if needed.
59+
- [ ] **[`conduit-connector-log`](https://github.com/ConduitIO/conduit-connector-log)**:
60+
Bump the Connector SDK `scripts/bump-sdk-in-connectors.sh vX.Y.Z`.
61+
Run `scripts/get-compare-link.sh ../conduit-connector-log/` and tag if needed.
62+
- [ ] **Bump built-in connectors on Conduit**: Run `scripts/bump-builtin-connectors.sh`
63+
- [ ] **Release Conduit** (see instructions below).
64+
65+
## Documentation
66+
67+
- [ ] Write a blog post.
68+
- [ ] Regenerate processor documentation on [`conduit-site`](https://github.com/ConduitIO/conduit-site)
69+
by running `cd src/processorgen/ && make generate`.
70+
- [ ] Update the banner on the [website](https://github.com/ConduitIO/conduit-site).
71+
⚠️ Remember to bump the `announcementBar.id` in `docusaurus.config.ts`.
72+
- [ ] Create a changelog on the [website](https://github.com/ConduitIO/conduit-site).
73+
- [ ] Search and replace the latest version in [`conduit-site`](https://github.com/ConduitIO/conduit-site).
74+
- [ ] Search and replace the latest version in [README.md](https://github.com/ConduitIO/conduit/blob/main/README.md).
75+
76+
## Releasing Conduit
77+
78+
Use the script [scripts/tag.sh](https://github.com/ConduitIO/conduit/blob/main/scripts/tag.sh) to ensure version conformity.
79+
80+
```sh
81+
scripts/tag.sh 1.2.3
82+
```
83+
84+
## After a Release
85+
86+
- [ ] Run `brew update conduit` and check latest version.
87+
- [ ] Check release artifacts are available for `OSX Darwin`, `Linux`, and `Windows`.
88+
- [ ] Pull Docker images.
89+
- [ ] Run a few [testing pipelines](https://github.com/ConduitIO/conduit/tree/main/examples/pipelines)
90+
to make sure things are still operational.
91+
92+
## Additional information
93+
94+
### Nightly Builds
95+
96+
- Nightly builds (binaries and Docker images) are provided and kept for 7 days.
97+
- The latest nightly Docker image is tagged with `latest-nightly`.
98+
99+
### Implementation
100+
101+
- The GitHub release is created with [GoReleaser](https://github.com/goreleaser/goreleaser/).
102+
- Nightly builds are triggered by a GitHub action, defined in [trigger-nightly.yml](/.github/workflows/trigger-nightly.yml).
103+
104+
### Notes
105+
106+
- The "Trigger nightly build" GitHub action requires a personal access token, not the GitHub token provided by Actions.
107+
108+
For more information, refer to
109+
[this](https://docs.github.com/en/actions/using-workflows/triggering-a-workflow#triggering-a-workflow-from-a-workflow).
110+
111+
---
112+
113+
Please ensure each step is completed before closing this issue.

Diff for: ‎.github/ISSUE_TEMPLATE/4-conduit-release.yml

-115
This file was deleted.

0 commit comments

Comments
 (0)