Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: improve the release task list with more explicit steps #602

Merged
merged 15 commits into from
Sep 11, 2024

Conversation

NickLarsenNZ
Copy link
Member

@NickLarsenNZ NickLarsenNZ commented Jul 12, 2024

Some of the tasks were too vague, and were done out of order.
This change should help improve the process for the next release.

Part of #632


Preview of release.md - 7ed5a81

Stackable Release XX.(X)X

[!IMPORTANT]
Important dates:

  • ... - Release planning
  • ... - Target release date

Release checklists

Replace the items in the task lists below with the applicable Pull Requests / Issues

General Pre-Requisites (before Feature Freeze)

Week 1

Preview Give feedback

Week 2

Preview Give feedback

Other Pre-Requisites (before Feature Freeze)

Search for open issues labeleded with scheduled-for/20XX-X

Other release-specific pre-requisites

Preview Give feedback

Feature freeze

This will not be so crucial with release branches, but is nonetheless sensible as it will make it easier to cherry-pick any release-related bugfixes from main into the release branch.

End of the release cycle (Release day)

Technical tasks

Preview Give feedback

Documentation tasks

Preview Give feedback

Marketing tasks can now reference published documentation.

Marketing tasks

Preview Give feedback

Post-release tasks

Preview Give feedback

@NickLarsenNZ NickLarsenNZ self-assigned this Jul 12, 2024
xeniape
xeniape previously approved these changes Jul 12, 2024
Copy link
Member

@xeniape xeniape left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@Techassi
Copy link
Member

I would like to see some more changes. I can push what I have in mind to this PR if @NickLarsenNZ is okay with that.

@NickLarsenNZ
Copy link
Member Author

I also had an idea to make some more issue templates in repos, and then refer to them in this task list.

That way they won't get too details in a small box.

@Techassi
Copy link
Member

I also had an idea to make some more issue templates in repos, and then refer to them in this task list.

That way they won't get too details in a small box.

I like the idea! Then we can keep it simple in this template and add more details in the operator issue template.

@adwk67
Copy link
Member

adwk67 commented Jul 23, 2024

Release notes
A comment on compiling the release notes. For 24.7, I compared the individual changelogs with the list of PRs and found the changelogs to be of little/no help:

  • some issues that are intentionally omitted from the CLs (e.g. docs) are still useful for highlighting to users (e.g. the production-ready rego rule documentation for Trino and HDFS)
  • some things are missed or incomplete (e.g. where a change spans more than one PR, or vice-versa)

It is quicker to run through an (overly) exhaustive list of PRs than to try and merge two different sources of information.
Clearly documented epics are also a great help as they link to the PRs e.g. #594 and stackabletech/demos#59.

@Techassi
Copy link
Member

Thanks for the input!

Regarding the changelogs, we had a lot of discussions via direct messages. At this point in time many voices raised issues with the changelogs in general (missing entries, linking to wrong PRs, partial entries, format and spelling errors) and the current workflow around them.

That's why I think it is appropriate to revisit the following decision: https://github.com/stackabletech/decisions/issues/9 which was put on hold. I would also be happy to spend time on coming up with a new workflow, documentation and changes required in our repos to make this approach work.

@NickLarsenNZ

This comment was marked as resolved.

@NickLarsenNZ NickLarsenNZ marked this pull request as ready for review September 10, 2024 15:21
Copy link
Member

@Techassi Techassi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, just one minor nit.

.github/ISSUE_TEMPLATE/pre-release-demos-nightly.md Outdated Show resolved Hide resolved
Co-authored-by: Techassi <sascha.lautenschlaeger@stackable.tech>
@NickLarsenNZ NickLarsenNZ merged commit 9c0eddf into main Sep 11, 2024
1 check passed
@NickLarsenNZ
Copy link
Member Author

Release notes A comment on compiling the release notes. For 24.7, I compared the individual changelogs with the list of PRs and found the changelogs to be of little/no help:

* some issues that are intentionally omitted from the CLs (e.g. docs) are still useful for highlighting to users (e.g. the production-ready rego rule documentation for Trino and HDFS)

* some things are missed or incomplete (e.g. where a change spans more than one PR, or vice-versa)

It is quicker to run through an (overly) exhaustive list of PRs than to try and merge two different sources of information. Clearly documented epics are also a great help as they link to the PRs e.g. #594 and stackabletech/demos#59.

@adwk67, the product image update templates have Acceptance Criteria for release note text to be provider, and a release-note label to be added if necessary.

Other templates will also need this, and will follow the same idea.

NickLarsenNZ added a commit that referenced this pull request Oct 2, 2024
* chore: restore container images tracking issue.

It was removed in #605

- [ ] Decide what to do with [docker-images/pre-release.md](https://github.com/stackabletech/docker-images/blob/5324e044a8aaac10e68767ba2b3c39e2623724f1/.github/ISSUE_TEMPLATE/pre-release.md?plain=1)

See: #602 (comment)

* chore: refer to renamed template from stackabletech/docker-images#850

* chore: remove old template
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

4 participants