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

PULSEDEV-00000 feedzai-openml: Include release process in README #67

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

PULSEDEV-00000 feedzai-openml: Include release process in README #67

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,3 +63,18 @@ After providing all the necessary information (your new provider groupId, artifa

This project makes use of the [jgitver Maven plugin](https://github.com/jgitver/jgitver). When using Intellij IDEA you
must configure the project to skip the plugin altogether. [See the related issue](https://github.com/jgitver/jgitver-maven-plugin/wiki/Intellij-IDEA-configuration).

## Releasing

If the hotfix branch is ready, you needed to create an annotated tag pointing to the hotfix branch head (example below for releasing version 1.2.29):
Copy link

Choose a reason for hiding this comment

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

Just a small rewording suggestion (the current wording is fine too, so no objections if you prefer it):

Suggested change
If the hotfix branch is ready, you needed to create an annotated tag pointing to the hotfix branch head (example below for releasing version 1.2.29):
If the hotfix branch is ready to be published, you needed to create an annotated tag pointing to the head of the hotfix branch. Below is an example for releasing version 1.2.29:


```bash
# Ensure the tag is made on the udpated branch
Copy link

Choose a reason for hiding this comment

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

Suggested change
# Ensure the tag is made on the udpated branch
# Ensure the branch is up-to-date before applying the tag

git fetch -a
git checkout origin/hf-1.2.X
git tag -a 1.2.29
# Your EDITOR will open. Write a good message and save as it is used on Github as a release message
Copy link

Choose a reason for hiding this comment

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

Suggested change
# Your EDITOR will open. Write a good message and save as it is used on Github as a release message
# The command above will launch your default CLI text editor.
# Write an informative message and save the contents, which will be used on GitHub as a release message.

git push origin 1.2.29
```

Then you need to [create a new release](https://github.com/feedzai/feedzai-openml/releases/new) with this tag and the description according [to the previous ones](https://github.com/feedzai/feedzai-openml/releases).