Skip to content

Commit

Permalink
Add release documentation to README.md (#23)
Browse files Browse the repository at this point in the history
Signed-off-by: Nathan Gillett <[email protected]>
  • Loading branch information
negillett authored Mar 24, 2022
1 parent c153677 commit 5845260
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 26 deletions.
31 changes: 14 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,21 +123,18 @@ tox -e static
tox -e cov
```

### build and upload a new release

- update all occurrences of `__version__`
- `python3 setup.py clean`
- `python3 setup.py sdist`
- `twine check dist/*`
- `twine upload dist/*`
- push latest to repo
- create new release on github

upload test or release candidate:
- twine upload --repository-url https://test.pypi.org/legacy/ dist/*

### python packaging resources
### Releasing
To release a new version of this library, authorized developers should;
- Prepare a signed release commit updating `version` in setup.py
- Tag the commit using [Semantic Versioning](https://semver.org/spec/v2.0.0.html)
prepended with "v"
- Push the tag

E.g.,
```
git commit -sm "Release v0.3.1"
git tag v0.3.1
git push --follow-tags
```

- https://packaging.python.org/
- https://packaging.python.org/tutorials/packaging-projects/
- https://realpython.com/pypi-publish-python-package/
A Github workflow will then automatically release the version to PyPI.
9 changes: 0 additions & 9 deletions osc_ingest_trino/__init__.py
Original file line number Diff line number Diff line change
@@ -1,12 +1,3 @@
"""
osc-ingest-tools
python tools to assist with standardized data ingestion workflows for the OS-Climate project
"""

# defines the release version for this python package
__version__ = "0.3.1"

from .boto3_utils import attach_s3_bucket, upload_directory_to_s3
from .dotenv_utils import load_credentials_dotenv
from .sqlcols import enforce_partition_column_order, enforce_sql_column_names, sql_compliant_name
Expand Down

0 comments on commit 5845260

Please sign in to comment.