This repository has been archived by the owner on Oct 8, 2019. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add changelog, release docs, bump version to 1.0.0.
- Loading branch information
Showing
3 changed files
with
60 additions
and
1 deletion.
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,14 @@ | ||
# Change log | ||
|
||
All notable changes to this project will be documented in this file, | ||
which uses the format described in | ||
[keepachangelog.com](http://keepachangelog.com/). This project adheres | ||
to [Semantic Versioning](http://semver.org/). | ||
|
||
## [Unreleased][unreleased] | ||
|
||
## 1.0.0 - 2018-06-06 | ||
|
||
Initial release. | ||
|
||
[unreleased]: https://github.com/18F/cg-django-uaa/compare/v1.0.0...HEAD |
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,45 @@ | ||
Here's how to issue a new release. | ||
|
||
1. Bump the version number in `uswds_forms/__init__.py`. | ||
|
||
2. Move the "unreleased" section to a new version entry in | ||
`CHANGELOG.md`. | ||
|
||
3. Run `tox` to ensure that everything builds and | ||
installs ok. | ||
|
||
4. Commit and push your changes with a commit message like | ||
"Bump version to v1.0.4." | ||
|
||
5. Tag your version and push it to GitHub. For instance, if you're | ||
releasing v1.0.4, do: | ||
|
||
``` | ||
git tag -a v1.0.4 | ||
git push origin v1.0.4 | ||
``` | ||
|
||
When running `git tag`, you'll be prompted for a tag | ||
message. Consider copy-pasting the version notes from | ||
`CHANGELOG.md` for this, as whatever you enter will | ||
show up on the [GitHub releases page][]. | ||
|
||
6. If you haven't already done so, create a `~/.pypirc` file | ||
with the following content: | ||
|
||
``` | ||
[distutils] | ||
index-servers = | ||
pypi | ||
[pypi] | ||
repository: https://www.python.org/pypi | ||
username: 18f | ||
password: <your password> | ||
``` | ||
|
||
7. Run `python setup.py sdist upload`. The new release should now | ||
be visible on [pypi][]. | ||
|
||
[GitHub releases page]: https://github.com/18F/django-uswds-forms/releases | ||
[pypi]: https://pypi.python.org/pypi/django-uswds-forms |
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 |
---|---|---|
|
@@ -5,4 +5,4 @@ | |
from .fieldset_helper import * # NOQA | ||
|
||
|
||
VERSION = '0.0.4' | ||
VERSION = '1.0.0' |