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

CLI: Add readme to 'jetpack release' #21418

Merged
merged 4 commits into from
Oct 19, 2021
Merged

CLI: Add readme to 'jetpack release' #21418

merged 4 commits into from
Oct 19, 2021

Conversation

sdixon194
Copy link
Contributor

@sdixon194 sdixon194 commented Oct 14, 2021 •
edited
Loading

Changes proposed in this Pull Request:

Adds the tools/plugin-changelog-to-readme.sh to the CLI.

Jetpack product discussion

#21160

Does this pull request change what data or activity we track or use?

No

Testing instructions:

  • After running jetpack release <project> changelog and the CHANGELOG.md has been generated, follow the instructions to run jetpack release <project> readme
  • The readme.txt file should be updated properly.
  • I don't believe we need to know if we are working with a beta or not, so you shouldn't be prompted for that unless you're using the changelog command.
  • Any use cases that aren't covered?

@sdixon194 sdixon194 added [Status] Needs Review This PR is ready for review. [Tools] Development CLI The tools/cli to assist during JP development. labels Oct 14, 2021
@sdixon194 sdixon194 requested review from anomiex and kraftbj October 14, 2021 14:31
@github-actions
Copy link
Contributor

github-actions bot commented Oct 14, 2021 •
edited
Loading

Thank you for your PR!

When contributing to Jetpack, we have a few suggestions that can help us test and review your patch:

  • ✅ Include a description of your PR changes.
  • ✅ All commits were linted before commit.
  • ✅ Add a "[Status]" label (In Progress, Needs Team Review, ...).
  • ✅ Add testing instructions.
  • ✅ Specify whether this PR includes any changes to data or privacy.
  • ✅ Add changelog entries to affected projects

This comment will be updated as you work on your PR and make changes. If you think that some of those checks are not needed for your PR, please explain why you think so. Thanks for cooperation 🤖

The e2e test report can be found here. Please note that it can take a few minutes after the e2e tests checks are complete for the report to be available.

Once your PR is ready for review, check one last time that all required checks (other than "Required review") appearing at the bottom of this PR are passing or skipped.
Then, add the "[Status] Needs Team review" label and ask someone from your team review the code.
Once you’ve done so, switch to the "[Status] Needs Review" label; someone from Jetpack Crew will then review this PR and merge it to be included in the next Jetpack release.

anomiex
anomiex reviewed Oct 14, 2021
View reviewed changes
Copy link
Contributor

@anomiex anomiex left a comment

Choose a reason for hiding this comment

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

Simple enough. The inline comment on line 74 needs attention; the other you can ignore if you intended the double-spacing.

tools/cli/commands/release.js Outdated
// Check if we're working with a beta version.
if ( ! argv.devRelease && typeof argv.beta === 'undefined' ) {
// Check if we're working with a beta version and only if generating changlog.
if ( ! argv.devRelease && typeof argv.beta === 'undefined' && argv.script === 'changelog' ) {
Copy link
Contributor

Choose a reason for hiding this comment

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

This doesn't work too well for interactive mode, as argv.script will be unset until you make the call to promptForScript() just after this.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

changed the order of the prompts, which seems like a simple enough workaround here.

@anomiex anomiex added [Status] Needs Author Reply We need more details from you. This label will be auto-added until the PR meets all requirements. and removed [Status] Needs Review This PR is ready for review. labels Oct 14, 2021
@sdixon194 sdixon194 added [Status] Needs Review This PR is ready for review. and removed [Status] Needs Author Reply We need more details from you. This label will be auto-added until the PR meets all requirements. labels Oct 15, 2021
@anomiex anomiex added [Status] Needs Author Reply We need more details from you. This label will be auto-added until the PR meets all requirements. [Status] Ready to Merge Go ahead, you can push that green button! and removed [Status] Needs Review This PR is ready for review. labels Oct 15, 2021
@anomiex
Copy link
Contributor

anomiex commented Oct 15, 2021

Looks good to go, other than needing a master merge.

@jeherve jeherve added [Type] Enhancement Changes to an existing feature — removing, adding, or changing parts of it and removed [Status] Needs Author Reply We need more details from you. This label will be auto-added until the PR meets all requirements. labels Oct 19, 2021
@jeherve jeherve enabled auto-merge (squash) October 19, 2021 08:03
@jeherve jeherve merged commit 0db1d08 into master Oct 19, 2021
@jeherve jeherve deleted the add/cli-jetpack-release-readme branch October 19, 2021 08:16
@github-actions github-actions bot removed the [Status] Ready to Merge Go ahead, you can push that green button! label Oct 19, 2021
davidlonjon added a commit that referenced this pull request Oct 19, 2021
@davidlonjon
Merge branch 'master' into fix/boost-ui-issues
d49dcac 
* master:
  Releases: start 10.3-a.4 cycle (#21454)
  Atomic Release: prepare changelogs for today's release (#21453)
  Connection: fixing the bug with connect button not appearing for secondary users (#21450)
  CLI: Add readme to 'jetpack release' (#21418)
  Update handling and setting CCPA related cookies (#21337)
  Publicize: do not disable toggle connection control when RePublicize is enabled (#21373)
  External Media: Add bottom padding to Google Photos modal (#21201)
  Blog Subscription Widget: deprecate widget and transform to block (#21184)
davidlonjon added a commit that referenced this pull request Oct 19, 2021
@davidlonjon
Merge branch 'master' into add/boost-e2e-ci-integration
4489562 
# By Jeremy Herve (2) and others
# Via GitHub
* master:
  Releases: start 10.3-a.4 cycle (#21454)
  Atomic Release: prepare changelogs for today's release (#21453)
  Connection: fixing the bug with connect button not appearing for secondary users (#21450)
  CLI: Add readme to 'jetpack release' (#21418)
  Update handling and setting CCPA related cookies (#21337)
  Publicize: do not disable toggle connection control when RePublicize is enabled (#21373)
  External Media: Add bottom padding to Google Photos modal (#21201)
  Blog Subscription Widget: deprecate widget and transform to block (#21184)

# Conflicts:
#	projects/plugins/boost/tests/e2e/package.json
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@anomiex anomiex anomiex approved these changes

@kraftbj kraftbj Awaiting requested review from kraftbj

Assignees

@sdixon194 sdixon194

Labels
[Tools] Development CLI The tools/cli to assist during JP development. [Type] Enhancement Changes to an existing feature — removing, adding, or changing parts of it
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@sdixon194 @anomiex @jeherve