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

Ensure Single Copy of Release Notes #8378

Closed
wants to merge 1 commit into from
Closed

Conversation

djbrooke
Copy link
Contributor

What this PR does / why we need it:

We're in a state right now where we maintain two copies of our release notes - one in Github.com/iqss/dataverse/releases and one in the /docs folder. This isn't great, because if there are changes needed, people could make them in one of two places and they could fall out of sync. This PR makes documentation changes that will result in the single, post-release source of truth being the release notes in the github.com/iqss/dataverse/releases - any edits or additions would go there.

Which issue(s) this PR closes:

Closes #7988

Special notes for your reviewer:

Suggestions on how to test this:

Does this PR introduce a user interface change? If mockups are available, please link/include them here:

Is there a release notes update needed for this change?:

Additional documentation:

@scolapasta scolapasta self-assigned this Jan 31, 2022
Copy link
Member

@pdurbin pdurbin left a comment

Choose a reason for hiding this comment

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

I left a comment.

@@ -58,7 +58,7 @@ At or near release time:
- The "tag version" and "title" should be the number of the milestone with a "v" in front (i.e. v4.16).
- Copy in the content from the .md file
- For the description, follow post-4.16 examples at https://github.com/IQSS/dataverse/releases

- Delete the .md file in the source code. This is to ensure that only one copy of the notes lives on in the future, as a single source of truth.
Copy link
Member

Choose a reason for hiding this comment

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

@scolapasta this is the line I mentioned in standup that we might want to think about. That is, when does it make sense to remove the combined release note file from git?

I think of "merge develop into master" as the final step before a release with regard to commits. And since the release note file is temporary, we should probably remove it before this final step.

Copy link
Member

@pdurbin pdurbin left a comment

Choose a reason for hiding this comment

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

Just testing approval automation (not an actual approval).

@pdurbin
Copy link
Member

pdurbin commented Sep 29, 2022

Closing. There are merge conflicts because we merged PR #8877 which updates the "Making Releases" page. There was enough of a rewrite of that page that we should simply make a new PR to address #7988 some day.

I agree with where this PR was going. That is, let's only have one version of the release notes, the "live" version, rather than saving .md files in git.

@pdurbin pdurbin closed this Sep 29, 2022
@mreekie mreekie added bk2211 and removed bk2211 labels Nov 1, 2022
@scolapasta scolapasta removed their assignment Nov 17, 2022
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.

Process for updating release notes after a release
4 participants