Skip to content

Commit

Permalink
Added release instructions.
Browse files Browse the repository at this point in the history
  • Loading branch information
jdennes committed May 10, 2013
1 parent 53f8150 commit 5d0a41a
Show file tree
Hide file tree
Showing 3 changed files with 58 additions and 1 deletion.
2 changes: 1 addition & 1 deletion META.yml
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,6 @@ requires:
resources:
license: http://dev.perl.org/licenses/
bugtracker: https://github.com/campaignmonitor/createsend-perl/issues
homepage: http://campaignmonitor.github.com/createsend-perl/
homepage: http://campaignmonitor.github.io/createsend-perl/
repository: https://github.com/campaignmonitor/createsend-perl.git
version: v2.2.1
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -122,3 +122,7 @@ perldoc Net::CampaignMonitor
## Contributing

Please check the [guidelines for contributing](https://github.com/campaignmonitor/createsend-perl/blob/master/CONTRIBUTING.md) to this repository.

## Releasing

Please check the [instructions for releasing](https://github.com/campaignmonitor/createsend-perl/blob/master/RELEASE.md) the `Net::CampaignMonitor` module.
53 changes: 53 additions & 0 deletions RELEASE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
# Releasing createsend-perl

## Requirements

- You must have a [PAUSE](https://pause.perl.org/) account and must be a maintainer of the [Net::CampaignMonitor](https://metacpan.org/module/Net::CampaignMonitor) module.

## Prepare the release

- Increment version constants in the following files, ensuring that you use [Semantic Versioning](http://semver.org/):
* `lib/Net/CampaignMonitor.pm` (both `$VERSION` _and_ the `pod` documentation section)
* `META.yml`
- Add an entry to `HISTORY.md` which clearly explains the new release.
- Write `Makefile` and run tests:

```
perl Makefile.PL && make test
```

- Commit your changes:

```
git commit -am "Version X.Y.Z"
```

- Tag the new version:

```
git tag -a vX.Y.Z -m "Version X.Y.Z"
```

- Push your changes to GitHub, including the tag you just created:

```
git push origin master --tags
```

- Ensure that all [tests](https://travis-ci.org/campaignmonitor/createsend-perl) pass.

## Package the module

```
perl package.pl vX.Y.Z
```

This packages a distribution to a file named something like `../Net-CampaignMonitor-vX.Y.Z.tar.gz`. You're now ready to release the package.

## Release the module

Log in to [PAUSE](https://pause.perl.org/) and choose the _Upload a file to CPAN_ option from the menu on the left hand side.

Then click _Choose File_, choose the `Net-CampaignMonitor-vX.Y.Z.tar.gz` file you packaged in the previous step, and click _Upload this file from my disk_ to upload the distribution.

You should receive an email confirming the upload, as well as an email confirming that the package has been indexed by the PAUSE indexer. All done!

0 comments on commit 5d0a41a

Please sign in to comment.