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.

Sign up for GitHub

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

Jump to bottom

Release 0.6.0 #725

Closed
11 tasks done
markmandel opened this issue Mar 30, 2023 · 17 comments · Fixed by #759
Closed
11 tasks done

Release 0.6.0 #725

markmandel opened this issue Mar 30, 2023 · 17 comments · Fixed by #759
Labels
kind/release Checklist for a release
Milestone
0.6.0

Comments

@markmandel
Copy link
Member

markmandel commented Mar 30, 2023 •
edited
Loading

Milestone: https://github.com/googleforgames/quilkin/milestone/4

Issue is for discussion on what should be in/out of the release.

Checklist of items blocking release at this stage:

Move documentation for relay to experimental?
@markmandel markmandel added the kind/release Checklist for a release label Mar 30, 2023
@markmandel markmandel added this to the 0.6.0 milestone Mar 30, 2023
@markmandel
Copy link
Member Author

@XAMPPRocky did I miss anything?

@markmandel markmandel pinned this issue Mar 30, 2023
@XAMPPRocky
Copy link
Collaborator

Nothing that currently comes to mind, if something important pops up we can always make a patch release.

@markmandel
Copy link
Member Author

Added a section to check on the examples.

XAMPPRocky added a commit that referenced this issue Apr 3, 2023
@XAMPPRocky
Add experimental notification in the docs
29cd5e8 
work on #725
@XAMPPRocky XAMPPRocky mentioned this issue Apr 3, 2023
Merged
XAMPPRocky added a commit that referenced this issue Apr 4, 2023
@XAMPPRocky
Add experimental notification in the docs (#730)
4e5d0d4 
work on #725
markmandel added a commit to markmandel/quilkin that referenced this issue Apr 13, 2023
@markmandel
Use GitHub's Changelog Generation
d871811 
Remove `ferrarimarco/github-changelog-generator` as that was extremely
flaky, and required some maintenance of secrets, and replace it with
GitHubs
automation.

Updated the release checklist as well to match.

Snuck in a small typo on the release README.md as well.

Work on googleforgames#725
@markmandel markmandel mentioned this issue Apr 13, 2023
Merged
XAMPPRocky pushed a commit that referenced this issue Apr 13, 2023
@markmandel
Use GitHub's Changelog Generation (#735)
87e132b 
Remove `ferrarimarco/github-changelog-generator` as that was extremely
flaky, and required some maintenance of secrets, and replace it with
GitHubs
automation.

Updated the release checklist as well to match.

Snuck in a small typo on the release README.md as well.

Work on #725
@markmandel markmandel changed the title Release Release 0.6.0 Apr 26, 2023
@markmandel
Copy link
Member Author

Finally able to get this release done.

I'd like to get #749 into the release, but it's possibly not critical, and I know you are swamped @XAMPPRocky -- what do you think, should I get a release running or should we wait for #749? (it only needs docs).

@markmandel
Copy link
Member Author

Forgot to note -- I'm going to check on the Grafana dashboards and examples now, so there is some time.

@markmandel
Copy link
Member Author

Grafana dashboards look good!

image

Working through the examples - finding a few breaking changes, but nothing major so far.

@markmandel
Copy link
Member Author

Got the sidecar examples working, just needed some small config changes.

xDS is next.

@markmandel
Copy link
Member Author

markmandel commented Jun 22, 2023 •
edited
Loading

xDS works. Just noting to myself I think I didn't test the sidecar compression example... it doesn't look like it would work as I have it now (should be using --port). Update: didn't pull changes.

markmandel added a commit to markmandel/quilkin that referenced this issue Jun 23, 2023
@markmandel
Update examples to work with upcoming 0.6.0
cc45c9c 
Updates all examples to work with new default ports and changes to
configuration options.

Work on googleforgames#725
@markmandel markmandel mentioned this issue Jun 23, 2023
Merged
XAMPPRocky pushed a commit that referenced this issue Jun 27, 2023
@markmandel
Update examples to work with upcoming 0.6.0 (#755)
15be84e 
Updates all examples to work with new default ports and changes to
configuration options.

Work on #725
markmandel added a commit to markmandel/quilkin that referenced this issue Jun 29, 2023
@markmandel
Update Docs for 0.6.0 Release
648986c 
This updates documentation for the upcoming release, and fixes up
documentation for some of the new areas and concepts.

This includes:

* Moved "Configuration" into the proxy configuration section, since
that is primarily what it covers now (everything else is command line
arguments).
* We had `xds` as a folder twice for some reason, so deleted a copy.
* A bunch of smaller fixes across those areas.

Work on googleforgames#725
@markmandel markmandel mentioned this issue Jun 29, 2023
Merged
@markmandel
Copy link
Member Author

@XAMPPRocky I think we're pretty close to a release! Shall we wait on #746 - or just cut the release? (that's more based on your schedule).

Happy to wait, but figured I would check.

@XAMPPRocky
Copy link
Collaborator

Let's not wait, it can always be in the next release.

Generally I prefer to release consistently and often, even if it means not all the features we've added are available.

@markmandel
Copy link
Member Author

SGTM. I'll get moving on the release!

@markmandel
Copy link
Member Author

markmandel commented Jul 7, 2023 •
edited
Loading

Release Checklist for Release 0.6.0

Prerequisites

  • Have at least Editor level access to quilkin Google Cloud project.
  • Local gcloud configuration is pointing at the quilkin Google Cloud project.
  • Local git remote upstream points at [email protected]:googleforgames/quilkin.git.

Steps

  • Review that closed issues have appropriate tags for the changelog.
  • Review that merged PRs have appropriate tags for the changelog.
  • Run git remote update && git checkout main && git reset --hard upstream/main to ensure your code is in line
    with upstream.
  • Update Cargo version for release
    • Edit the version field in ./Cargo.toml and remove the -dev suffix.
    • Edit the quilkin-macros dependency in ./Cargo.toml and remove the -dev suffix.
    • Edit the version field in ./macros/Cargo.toml and remove the -dev suffix.
  • cd to ./build/release and run make to submit the cloud build
  • Download all the artifacts from the cloud build.
  • Review license.html to ensure that there aren't any new MPL, or CDDL dependencies from the last
    release. If there are:
    • Add the dependencies to archive_dependencies.sh
      so that the source is archived in the container image.
    • Reset checklist back to "run make to submit the cloud build", and start from there again.
  • Run cd macros && cargo publish --dry-run --allow-dirty and ensure there are no issues.
  • Run cargo clippy in the root directory, and ensure there are no issues.
  • Add a release item to README.md "Documentation" > "Releases" list with related links in reverse chronological
    order.
  • Remove any data-proofer-ignore attributes from links in the documentation in ./docs.
  • Create a draft Github release
    • Populate the tag with v0.6.0
    • Click Generate release notes to generate the change log for this release.
    • Copy the release notes from the draft release and paste it at the top of CHANGELOG.md.
    • Using the
      Github release template
      update the generated release notes with a description, and relevant changelog sections.
    • Attach all the cloud build artifacts to the draft GitHub release.
  • Submit these changes as a PR, and merge with approval.
  • Run git remote update && git checkout main && git reset --hard upstream/main to ensure your code is in line
    with upstream.
  • Run git checkout -b release-0.6.0 && git push upstream release-0.6.0 to create a release branch.
  • Publish to crates.io/crates/quilkin-macros: run cd macros && cargo publish
  • Publish to crates.io/crates/quilkin: run cargo publish
  • Submit the release.
  • Post an announcement to the mailing list.
  • Post to the Twitter account.
  • Update Cargo version for development
    • Edit Cargo.toml and increment the minor version and apply the -dev suffix to the
      version.
    • Edit the quilkin-macros dependency in ./Cargo.toml and increment the minor version
      and apply the -dev suffix to the version.
    • Edit the version field in ./macros/Cargo.tomland increment the minor version
      and apply the -dev suffix to the version.
  • Submit this change as a PR, and merge with approval.

Congratulation! 🎉 You have successfully released Quilkin!

@markmandel
Copy link
Member Author

Release draft in case you wish to review @XAMPPRocky https://github.com/googleforgames/quilkin/releases/edit/untagged-e6b274491fe5e026bcec

@markmandel markmandel mentioned this issue Jul 7, 2023
Merged
@XAMPPRocky
Copy link
Collaborator

@markmandel I get a 404 on that link

@markmandel
Copy link
Member Author

@XAMPPRocky Oh, it must change every time I click "save draft" - check https://github.com/googleforgames/quilkin/releases to see the draft release at the top.

@markmandel
Copy link
Member Author

That being said - I'm wrapping up the release now. But the release is editable after the fact if you wish to make updates 👍🏻

@XAMPPRocky
Copy link
Collaborator

Looks good to me, I'll write up more on the relay stuff for the next release

markmandel added a commit to markmandel/quilkin that referenced this issue Jul 10, 2023
@markmandel
Prep: 0.7.0-dev
2c0a797 
* Update versions to 0.7.0-dev
* Small improvements to release process
* Fix some URL testing features / flakiness.

Closes googleforgames#725
@markmandel markmandel mentioned this issue Jul 10, 2023
Merged
XAMPPRocky pushed a commit that referenced this issue Jul 11, 2023
@markmandel
Prep: 0.7.0-dev (#759)
8a3aa37 
* Update versions to 0.7.0-dev
* Small improvements to release process
* Fix some URL testing features / flakiness.

Closes #725
@XAMPPRocky XAMPPRocky unpinned this issue Sep 18, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
kind/release Checklist for a release
Projects
None yet
Milestone
0.6.0
Development

Successfully merging a pull request may close this issue.

Prep: 0.7.0-dev markmandel/quilkin
2 participants
@markmandel @XAMPPRocky