Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Document how to make a release of the project in a contributing file. Also add the contributing file to the Cabal build file. Closes #10
- Loading branch information
1 parent
f89b650
commit 3a9bbf7
Showing
2 changed files
with
26 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
# Contributing | ||
|
||
## Releases | ||
Whenever a new release of the program is made, there are a few things that should be updated: | ||
|
||
* `CHANGELOG.md` - Information the changes in the new release should be added. | ||
* `pixelated-avatar-generator.cabal` - The version should be updated. | ||
|
||
Once those changes have been made, a release for the application should be made on GitHub, and the following files should be included: | ||
|
||
* `doc.zip` - A zip archive of the generated haddock documentation. | ||
* `pixelated-avatar-generator` - An executable Linux binary of the program. | ||
|
||
The Haddock documentation and Linux binary can be generated by running the following commands: | ||
|
||
``` | ||
stack build | ||
stack haddock | ||
``` | ||
|
||
Once the release on GitHub has been made, the package should then be released on Hackage. This can be done by generating the package with the following command, and uploading it to Hackage. | ||
|
||
``` | ||
stack sdist | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters