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

Commit PR notes to draftlogs and add scripts to provide draft release notes (CHANGELOG.md) and empty draftlogs #5780

Merged
merged 10 commits into from
Jul 7, 2021

Conversation

archmoj
Copy link
Contributor

@archmoj archmoj commented Jun 28, 2021

Resolves #5778.

Running

npm run use-draftlogs

simply updates CHANGELOG.md.

@plotly/plotly_js

@archmoj archmoj added this to the NEXT milestone Jun 28, 2021
@archmoj archmoj changed the title Commit PR changelogs to draftlogs and add scripts to provide draft release notes and empty draftlogs Commit PR notes to draftlogs and add scripts to provide draft release notes (CHANGELOG.md) and empty draftlogs Jun 28, 2021
@nicolaskruchten
Copy link
Contributor

I like it!

all.Changed.push(message);
} else if(filename.endsWith('_fix.md')) {
all.Fixed.push(message);
}
Copy link
Collaborator

Choose a reason for hiding this comment

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

Else throw an error, logging the filename as having been ignored.

Might want to also loosen the endsWith tests - to eg filename.toLowerCase().indexOf('_add') !== -1 so stuff like 5678_Added.md will still be picked up.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think we have a test which disallows use of uppercase in filenames.

Copy link
Collaborator

Choose a reason for hiding this comment

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

We do test for uppercase, but I don't think it'll dig into the draftlogs dir. And there's still add vs adds vs added etc. Anyway the main thing is to throw an error if we ignore the file. After adding that if you still want to be strict about names that's ok, it'll just occasionally make more work during release if we get an incorrect name.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good call. Addressed in 3a91c0e.

@alexcjohnson
Copy link
Collaborator

Looks good! Can you add notes on creating these md files to the PR template, and add notes on the new package scripts to the release procedure?

@archmoj
Copy link
Contributor Author

archmoj commented Jun 30, 2021

Looks good! Can you add notes on creating these md files to the PR template, and add notes on the new package scripts to the release procedure?

Good call. Done in eefab9b.

archmoj and others added 2 commits July 7, 2021 09:56
Co-authored-by: Alex Johnson <[email protected]>
Co-authored-by: Alex Johnson <[email protected]>
Copy link
Collaborator

@alexcjohnson alexcjohnson left a comment

Choose a reason for hiding this comment

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

Looks good! 💃

@archmoj archmoj merged commit a0a9040 into master Jul 7, 2021
@archmoj archmoj deleted the draft-release-notes branch July 7, 2021 13:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature something new
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Commit PR logs and add a script to help draft the next release notes
3 participants