Add git_info module; Include create release GitHub Actions; Include PyPI publishing GitHub Actions

UAL-RE / redata-commons

Commons code used by ReDATA codebases

MIT License

1 stars 2 forks source link

Add git_info module; Include create release GitHub Actions; Include PyPI publishing GitHub Actions #4

Closed astrochun closed 3 years ago

astrochun commented 3 years ago

Closes #2 Closes #3 Closes #6

[x] Bump version from v0.0.1 -> v0.1.0
[x] Add minimal CHANGELOG file
[x] Update README.md with more information
[x] Add docstrings for GitInfo
[x] Add create release GitHub Action #3
[x] Add git_info module
[x] Add PyPI publishing GitHub actions #6
[x] Add PyPI API token secrets (@astrochun) [Note: token will need to change with scope limited to redata package] #6

Commit history:

Add git_info module
Add init.py for redata_commons
Add unit tests for git_info module
Add setup.py script for packaging
Add python-package GitHub Actions
Add create-release.yml #3 [ci skip]
Exclude PyCharm from .gitignore
git_info: Remove os library usage
Add MANIFEST.in [ci skip]

astrochun commented 3 years ago

I was able to build locally. Except for a minor fix, everything looks good. I was wondering if we should test it on https://test.pypi.org/

What was the minor fix that was needed?

Yes, we can publish say v0.0.1 to test PyPI. Note that versioning is fix on PyPI. Once you publish you can't re-publish with the same version. It's not like GitHub where you can delete a tag to re-tag it. The final version of this release is 0.1.0 so that won't be an issue here. You can pip install --index-url https://test.pypi.org/simple/ redata=0.1.0 to use Test PyPI. Once I have it published I'll note it in the PR.

damian-romero commented 3 years ago

Yes, we can publish say v0.0.1 to test PyPI. Note that versioning is fix on PyPI. Once you publish you can't re-publish with the same version. It's not like GitHub where you can delete a tag to re-tag it. The final version of this release is 0.1.0 so that won't be an issue here. You can pip install --index-url https://test.pypi.org/simple/ redata=0.1.0 to use Test PyPI. Once I have it published I'll note it in the PR.

Sounds good. I'll be on the lookout for when you want me to merge this into main. If I understand correctly, this repository will be using GitHub flow instead of git flow.

astrochun commented 3 years ago

I did publish v0.0.1 to Test PyPI: https://test.pypi.org/project/redata/

pip install -i https://test.pypi.org/simple/ redata==0.0.1 should work