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

Improve release instructions #2103

Merged
merged 7 commits into from
Sep 1, 2020
Merged

Improve release instructions #2103

merged 7 commits into from
Sep 1, 2020

Conversation

cbliard
Copy link
Contributor

@cbliard cbliard commented Aug 26, 2020

Is your pull request related to a problem? Please describe.

While releasing Cucumber-JVM 6.6.0, we ran into some issues:

  • We (wrongly) assumed that setting the version is done by editing it in the root pom.xml, which made the release process because versions in root pom and submodules pom do not match
  • We manually reverted some files and got issues with the update-changelog.sh script
  • We were not sure that credentials for pushing artifacts to sonatype would automatically work

Overall the overall release process went smoothly. Anyway we think we can improve it even further.

Describe the solution you have implemented

  • Make update-changelog.sh more robust and runnable on osx
  • Add information about proper way to set version
  • Clarify what credentials information is needed
  • Remove empty sections automatically

@cbliard cbliard marked this pull request as draft August 26, 2020 10:13
@coveralls
Copy link

coveralls commented Aug 26, 2020

Coverage Status

Coverage remained the same at 86.198% when pulling d6d49b6 on improve-release-instructions into 26d1ad7 on main.

@cbliard cbliard marked this pull request as ready for review August 26, 2020 14:52
@cbliard
Copy link
Contributor Author

cbliard commented Aug 26, 2020

I really feel like we could add some unit tests on `scripts/update-changelog.sh. Some kind of golden testing ones where we have input files and expected outputs for many different changelog files would be easy to maintain.

Copy link
Contributor

@mpkorstanje mpkorstanje left a comment

Choose a reason for hiding this comment

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

Looking good!

Don't forget to copy this to:

I really feel like we could add some unit tests on `scripts/update-changelog.sh. Some kind of golden testing ones where we have input files and expected outputs for many different changelog files would be easy to maintain.

This script is executed in the docker container so it could be added to the docker image. And as part of building the image some tests could be added. This would also remove the duplication I mentioned above.

The docker image is kept in:

https://github.com/cucumber/cucumber-build

RELEASING.md Outdated Show resolved Hide resolved
RELEASING.md Outdated Show resolved Hide resolved
@mpkorstanje
Copy link
Contributor

I think we're good to go now.

@cbliard cbliard merged commit 9d16497 into main Sep 1, 2020
@cbliard cbliard deleted the improve-release-instructions branch September 1, 2020 15:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants