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

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

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

Conversation

ghost
Copy link

@ghost ghost commented Feb 17, 2022

@codecov
Copy link

codecov bot commented Feb 17, 2022

Codecov Report

Merging #67 (ff5b940) into master (621b2dc) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff            @@
##             master      #67   +/-   ##
=========================================
  Coverage     84.82%   84.82%           
  Complexity      281      281           
=========================================
  Files            38       38           
  Lines           738      738           
  Branches         69       69           
=========================================
  Hits            626      626           
  Misses           79       79           
  Partials         33       33           


## 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):

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:

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):

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

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

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.

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.

1 participant