Skip to content

HDDS-5084. Include HISTORY.md/SECURITY.md/CONTRIBUTING.md in the release artifacts.#2140

Merged
elek merged 2 commits intoapache:masterfrom
elek:more-md
Apr 19, 2021
Merged

HDDS-5084. Include HISTORY.md/SECURITY.md/CONTRIBUTING.md in the release artifacts.#2140
elek merged 2 commits intoapache:masterfrom
elek:more-md

Conversation

@elek
Copy link
Member

@elek elek commented Apr 9, 2021

JIRA: https://issues.apache.org/jira/browse/HDDS-5084

What changes were proposed in this pull request?

During the ozone-1.1.0 vote I realized that HISTORY.md/SECURITY.md/CONTRIBUTING.md files are missing from the bin and src artifacts. I think they include very useful information and would be better to include them in the release artifacts.

How was this patch tested?

mvn clean install -Dmaven.javadoc.skip=true -DskipTests -Psign,dist,src -Dtar -Dgpg.keyname=$CODESIGNINGKEY
  cd hadoop-ozone/dist/target/
tar tzf hadoop-ozone-1.1.0-SNAPSHOT.tar.gz
tar tzf hadoop-ozone-1.1.0-src-SNAPSHOT.tar.gz

@elek elek changed the title Include HISTORY.md/SECURITY.md/CONTRIBUTING.md in the release artifacts. HDDS-5084. Include HISTORY.md/SECURITY.md/CONTRIBUTING.md in the release artifacts. Apr 9, 2021
Copy link
Contributor

@mukul1987 mukul1987 left a comment

Choose a reason for hiding this comment

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

We should update the History.md, it is quite old right now. Including it in the current form in the release doesn't makes sense.

@adoroszlai
Copy link
Contributor

We should update the History.md, it is quite old right now.

@mukul1987 This is a good suggestion, but I disagree with the other statement:

Including it in the current form in the release doesn't makes sense.

  1. It is not going to be part of the 1.1.0 release, so there is plenty of time to update it until the next one.
  2. It's not only about HISTORY.md, but other two docs as well.
  3. Writing prose for the history doc is quite distinct from updating a script to copy some files. It may very well be updated by other people, not necessarily @elek.

So I think this change is fine in its scope.

@mukul1987
Copy link
Contributor

mukul1987 commented Apr 9, 2021

Fair point @adoroszlai. Can we please create a followup jira for updating the History.md and other files and mark it as a blocker for 1.2.0 release? I feel if we will update the history by the next release, then we should be good.

@elek
Copy link
Member Author

elek commented Apr 12, 2021

Thanks the suggestion @mukul1987, very good point.

It seems to be a small update, so I created the patch itself (please see #2149). And agree: as we have PRs for both problems in our radar we can merge the two PRs in any order.

@mukul1987
Copy link
Contributor

Thanks Marton. +1 for this patch as well.
I have already added +1 to the other patch.

Thanks for updating the file.

Copy link
Contributor

@mukul1987 mukul1987 left a comment

Choose a reason for hiding this comment

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

+1,lgtm

@elek
Copy link
Member Author

elek commented Apr 19, 2021

Thanks the review @mukul1987 @ayushtkn and @adoroszlai

I am merging it after the green build.

@elek elek merged commit 8badca9 into apache:master Apr 19, 2021
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.

4 participants