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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a script to create the release of this gem #560

Merged
merged 1 commit into from Jan 6, 2022
Merged

Conversation

jcouball
Copy link
Member

@jcouball jcouball commented Jan 6, 2022

Signed-off-by: James Couball jcouball@yahoo.com

Your checklist for this pull request

馃毃Please review the guidelines for contributing to this repository.

  • Ensure all commits include DCO sign-off.
  • Ensure that your contributions pass unit testing.
  • Ensure that your contributions contain documentation if applicable.

Description

bin/create-release

This PR adds the bin/create-release script which automates the following:

  • Assert that all prerequisites for creating the release are met (see below)
  • Create the release branch locally
  • Update and commit the CHANGELOG.md and version.rb files
  • Create the release tag
  • Push the new commit and tag to the remote
  • Create the GitHub release with the change log listing
  • Create the release PR

This script checks the following prerequisites:

  • The current directory is the top-level directory of the git repo with the default branch checked out
  • There are no uncommitted changes in the work tree or staging area
  • The Ruby bundle is created and up to date
  • Docker is installed and running
  • The gh command is installed

bin/setup and bin/console

This PR also adds two scripts found in most Ruby projects:

  • bin/setup: automates the setup a contributor needs to do after cloning the repository prior to running rake
  • bin/console: drops you into an IRB console with the lib/git code already required.

Signed-off-by: James Couball <jcouball@yahoo.com>
@jcouball jcouball merged commit c987a74 into master Jan 6, 2022
7 of 8 checks passed
@jcouball jcouball deleted the create-release branch Jan 6, 2022
@jcouball jcouball mentioned this pull request Jan 6, 2022
3 tasks
p-mongo pushed a commit to p-mongodb/ruby-git that referenced this issue May 27, 2022
鈥' into mine

* p/diff-submodule: (36 commits)
  Support --submodule option to git diff.
  Support the --all option for git fetch (ruby-git#583)
  Workaround to get JRuby build working (ruby-git#582)
  Update README.md (ruby-git#580)
  Make the directory param to Git.clone optional (ruby-git#578)
  Make Git::URL.clone_to handle cloning to bare and mirror repos (ruby-git#577)
  Add Git::URL #parse and #clone_to methods (ruby-git#575)
  Use the head version of yard (ruby-git#573)
  Release v1.11.0
  Supress unneeded test output (ruby-git#570)
  Add support for fetch options "--force/-f" and "--prune-tags/-P". (ruby-git#563)
  Fix bug when grepping lines that contain numbers surrounded by colons (ruby-git#566)
  remove from maintainer (ruby-git#567)
  Address command line injection in Git::Lib#fetch
  Release v1.10.2 (ruby-git#561)
  Add create-release, setup, and console dev scripts (ruby-git#560)
  Store tempfile objects to prevent deletion during tests (ruby-git#555)
  Release v1.10.1 (ruby-git#553)
  Properly escape double quotes in shell commands on Windows (ruby-git#552)
  Properly unescape diff paths (ruby-git#504)
  ...

* p/set-url-push: (36 commits)
  Add :push option to remote_set_url.
  Support the --all option for git fetch (ruby-git#583)
  Workaround to get JRuby build working (ruby-git#582)
  Update README.md (ruby-git#580)
  Make the directory param to Git.clone optional (ruby-git#578)
  Make Git::URL.clone_to handle cloning to bare and mirror repos (ruby-git#577)
  Add Git::URL #parse and #clone_to methods (ruby-git#575)
  Use the head version of yard (ruby-git#573)
  Release v1.11.0
  Supress unneeded test output (ruby-git#570)
  Add support for fetch options "--force/-f" and "--prune-tags/-P". (ruby-git#563)
  Fix bug when grepping lines that contain numbers surrounded by colons (ruby-git#566)
  remove from maintainer (ruby-git#567)
  Address command line injection in Git::Lib#fetch
  Release v1.10.2 (ruby-git#561)
  Add create-release, setup, and console dev scripts (ruby-git#560)
  Store tempfile objects to prevent deletion during tests (ruby-git#555)
  Release v1.10.1 (ruby-git#553)
  Properly escape double quotes in shell commands on Windows (ruby-git#552)
  Properly unescape diff paths (ruby-git#504)
  ...
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.

None yet

1 participant