Skip to content

Check Package Version Matches Release Tag On Deployment #83

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ferdia-sopermaccafraidh-lrn merged 2 commits into from
Sep 23, 2024
Merged

Check Package Version Matches Release Tag On Deployment #83

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e79c855
[FEATURE] Check for package version to match git tag in release workflow
Aug 23, 2024
95b404a
[DOC] Updated release instructions to reflect changes.
Aug 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .github/workflows/dispatch-release-pypi.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,12 @@ jobs:
- name: Check out code
uses: actions/checkout@v3

# grep exits with a non-zero exit code if a match is not found
- name: Check Library Version matches ${{ github.ref_name }}
id: check_version
run: |
grep "${{ github.ref_name }}" learnosity_sdk/_version.py
Comment thread
ferdia-sopermaccafraidh-lrn marked this conversation as resolved.

- name: Set up Python
uses: actions/setup-python@v2
with:
Expand Down
7 changes: 4 additions & 3 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,10 @@ Alternatively, if you only care about the version you're currently running, you

# Deploying to PyPi

Run `make release` and follow the instructions to deploy the distributions to PyPi

You will need to be set up as a maintainer in order to do this.
1. Add a new entry to the [Changelog.md](./ChangeLog.md)
1. Merge your pull request after approval.
2. Create a new Release[https://github.com/Learnosity/learnosity-sdk-python/releases] with a new tag, and this tag will
be used as the new library version. Please autogenerate release notes to show differences.

[Issues]: https://github.com/Learnosity/learnosity-sdk-python/issues/new
[PRs]: https://github.com/Learnosity/learnosity-sdk-python/compare