Skip to content

Latest commit

 

History

History
63 lines (45 loc) · 1.69 KB

RELEASE-POLICY.md

File metadata and controls

63 lines (45 loc) · 1.69 KB
Raw

Updating Hydra gem procedure

Deprecations

Indicating Deprecations

Each of the ProjectHydra gems in hydra.gemspec make use of the deprecation gem. Below is our preferred method for indicating deprecation:

class Foo
  def bar
    Deprecation.warn(Foo, 'Foo#bar is deprecated. Please use Baz', caller)
    …
  end
end

By adhearing to the above deprecation semantic we are able to report deprecations when the Hydra gem is updated.

Reporting Deprecations on Hydra upgrades

The ./script/query-for-deprecation.rb is a tool to help report what methods have had a change in deprecation status.

Documentation for releases

Our primary location for documentation is the Github wiki associated with this project. All pages from the Github wiki should be copied to doc/ as part of a release.

Steps:

  1. Get the latest version of the wiki. Note that Github wikis are git repositories, so you can treat them like any other.

    # if you haven't yet done so, clone the wiki repo...
git clone [email protected]:projecthydra/hydra.wiki.git path/to/hydra.wiki

# or, if you have already cloned, then get the latest changes...
cd path/to/hydra.wiki
git pull

  2. Copy the wiki pages to doc/ directory of hydra repository.

    cp -a path/to/hydra.wiki/* path/to/hydra/doc/

  3. Commit the changes.

    cd path/to/hydra
git add doc/.
git commit -m "Updates the wiki docs"

This commit should then be included as part of the pull request for the new release. See "Making Changes" and "Submitting Changes" on the preferred way to submit pull requests.