Upload.java:38-39: Add description to releases. This will...

releasecat-maven-plugin

Don't panic! This is just a maven plugin that uploads/creates GitHub releases for your project. :) It is based on the excellent jcabi-github API, go check it out!

Why another GitHub-releases plugin?

Travis doesn't provide adequate support for release descriptions (aka changelog), see 1, 2, 3, 4
Ability to specify parameters from the command line or settings.xml. This allows dynamic deployments, free from the static configuration of your project's POM.
Project activity (there are very few projects and they're basically dead)

Feedback

Please direct any questions, feature requests or bugs to the issue tracker.

How to contribute?

See CONTRIBUTING.

License

releasecat-maven-plugin is licensed under the Apache License, Version 2.0. A copy of the license has been included in LICENSE.

Icon made by Freepik from www.flaticon.com is licensed by CC BY 3.0

	* @todo #3:30min jcabi-github should not be prepopulating optional attributes of fake
	* releases with default values like this. That's why this test is checking for
	* 'Description of the release'. I've opened https://github.com/jcabi/jcabi-github/issues/1362
	* for this issue. When that is fixed, come back here and refactor this test.

	* @todo #4:15min jcabi-github has a bug
	* (https://github.com/jcabi/jcabi-github/issues/1363) that makes it impossible to mark
	* a MkRelease as prerelease. When that is fixed, come back here and change 'assertFalse'
	* for 'assertTrue' and make sure it works.

	* @todo #1:30min Add description to releases. This will be useful for displaying changelogs
	* directly in the release. Right now we just have the tag and the name.

	* @todo #14:30min 'name' should be optional. If not specified then it's simply not set. Currently
	* we're always setting the release's name whether we have it or not.

	* @todo #1:30min Add ability to upload artifacts to releases. This will be useful when
	* someone wants to include sources and / or binaries.

	* @todo #17:30min Impediment on jcabi github: https://github.com/jcabi/jcabi-github/issues/1362.
	* Come back and change the test to nullValue() this test when that issue is fixed.

	* @todo #5:15min The following configurations must be marked as required: token, user, repo, tag.
	* 'Token' is used to authenticate against GitHub'; 'user' is the user to whom the project belongs
	* to; 'repo' is the name of the project; 'tag' is the name of the tag to apply to the release.

	* @todo #5:30min jcabi-github has a bug in how the MkReleaseAssets and MkReleaseAsset handle
	* the contents of the asset - see bug https://github.com/jcabi/jcabi-github/issues/1366.
	* After the bug is fixed, come back and unignore this test.

	* @todo #14:30min Replace 'user' with 'org'. The username can already be obtained via jcabi-github
	* using the token. 'org' must be optional: if specified then it is used as the "user".

	* @todo #1:30min Add ability to specify whether it's a prerelease or a full release. This
	* would be useful when uploading release candidates.

	* @todo #1:30min Add ability to read the contents of a text file and use that
	* the description of a release. This will be useful for chaining the output
	* of changelog plugins (usually to a file) into this plugin.

llorllale / releasecat-maven-plugin Goto Github PK

releasecat-maven-plugin's Introduction

releasecat-maven-plugin

Why another GitHub-releases plugin?

Feedback

How to contribute?

License

releasecat-maven-plugin's People

Contributors

Stargazers

Watchers

releasecat-maven-plugin's Issues

Recommend Projects

Recommend Topics

Recommend Org