Skip to content

Commit fba9291

Browse files
kwentkwent
committed
Add GitHub Actions publishing workflow and update project configuration
- Add GitHub Actions workflow for automated PyPI publishing on git tags - Add comprehensive publishing documentation in .github/PUBLISHING.md - Update pyproject.toml from Poetry to standard build system (setuptools) - Add Apache 2.0 license file and update project configuration - Update README.md with modern uv/build/twine publishing instructions - Add uv.lock for dependency management The workflow uses the proven uv/build/twine approach for reliable package publishing.
1 parent c41b8f2 commit fba9291

6 files changed

Lines changed: 666 additions & 25 deletions

File tree

‎.github/PUBLISHING.md‎

Lines changed: 115 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,115 @@
1+
# Publishing to PyPI
2+
3+
This repository uses GitHub Actions to automatically publish packages to PyPI when a new version tag is pushed.
4+
5+
## Setup Instructions
6+
7+
### 1. PyPI API Token
8+
9+
1. Go to [PyPI Account Settings](https://pypi.org/manage/account/)
10+
2. Scroll to "API tokens" section
11+
3. Click "Add API token"
12+
4. Set the token name (e.g., "rootly-python-github-actions")
13+
5. Set the scope to "Entire account" or specific to this project
14+
6. Copy the generated token (starts with `pypi-`)
15+
16+
### 2. GitHub Repository Secrets
17+
18+
1. Go to your GitHub repository
19+
2. Navigate to Settings → Secrets and variables → Actions
20+
3. Click "New repository secret"
21+
4. Add the following secret:
22+
- **Name**: `PYPI_API_TOKEN`
23+
- **Value**: The PyPI API token from step 1
24+
25+
### 3. Publishing a New Version
26+
27+
To publish a new version:
28+
29+
1. **Update the changelog** (if not already done):
30+
```bash
31+
# Edit CHANGELOG.md to add new version details
32+
```
33+
34+
2. **Create and push a version tag**:
35+
```bash
36+
# Create a new version tag (e.g., v1.2.3)
37+
git tag v1.2.3
38+
39+
# Push the tag to trigger the workflow
40+
git push origin v1.2.3
41+
```
42+
43+
3. **Monitor the workflow**:
44+
- Go to the "Actions" tab in your GitHub repository
45+
- Watch the "Publish Python 🐍 distribution 📦 to PyPI on tag" workflow run
46+
- The workflow will:
47+
- Install build tools (uv, build, twine)
48+
- Test the SDK imports
49+
- Build the package using Python build
50+
- Publish to PyPI using twine
51+
52+
### 4. Version Numbering
53+
54+
Follow [Semantic Versioning](https://semver.org/):
55+
- **MAJOR**: Incompatible API changes (e.g., `v2.0.0`)
56+
- **MINOR**: New functionality, backward compatible (e.g., `v1.1.0`)
57+
- **PATCH**: Bug fixes, backward compatible (e.g., `v1.0.1`)
58+
59+
### 5. Workflow Details
60+
61+
The GitHub Action workflow (`.github/workflows/publish.yml`) will:
62+
63+
1. **Trigger**: On any tag push (pattern `*`)
64+
2. **Environment**: Ubuntu latest with Python 3.12
65+
3. **Dependencies**: Install uv, build, and twine
66+
4. **Testing**: Verify SDK imports correctly
67+
5. **Build**: Create distribution packages using Python build
68+
6. **Publish**: Upload to PyPI using twine with API token
69+
70+
### 6. Manual Publishing (Alternative)
71+
72+
If you need to publish manually:
73+
74+
```bash
75+
# Install dependencies
76+
poetry install
77+
78+
# Update version in pyproject.toml
79+
poetry version 1.2.3
80+
81+
# Build the package
82+
poetry build
83+
84+
# Publish to PyPI
85+
poetry publish
86+
```
87+
88+
### 7. Testing on Test PyPI
89+
90+
For testing the publishing process, you can use Test PyPI:
91+
92+
1. Create a Test PyPI account and API token
93+
2. Add `PYPI_TEST_TOKEN` to GitHub secrets
94+
3. Modify the workflow to use `--repository testpypi` flag
95+
96+
### 8. Troubleshooting
97+
98+
**Common Issues:**
99+
100+
- **Permission denied**: Ensure the `PYPI_TOKEN` secret is correctly set
101+
- **Version conflict**: Make sure the version tag doesn't already exist on PyPI
102+
- **Import errors**: Check that all dependencies are correctly specified in `pyproject.toml`
103+
- **Build failures**: Verify the package structure and ensure all required files are included
104+
105+
**Workflow Monitoring:**
106+
- Check the Actions tab for detailed logs
107+
- Review the workflow output for specific error messages
108+
- Ensure the tag format matches the expected pattern (`v*`)
109+
110+
## Security Notes
111+
112+
- Never commit PyPI tokens to the repository
113+
- Use repository secrets for sensitive information
114+
- Consider using environment-specific tokens for different deployment stages
115+
- Regularly rotate API tokens for security

‎.github/workflows/publish.yml‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
name: Publish Python 🐍 distribution 📦 to PyPI on tag
2+
3+
on:
4+
push:
5+
tags:
6+
- '*'
7+
8+
jobs:
9+
build-and-publish:
10+
runs-on: ubuntu-latest
11+
steps:
12+
- name: Checkout code
13+
uses: actions/checkout@v4
14+
15+
- name: Set up Python
16+
uses: actions/setup-python@v5
17+
with:
18+
python-version: '3.12'
19+
20+
- name: Install uv and build tools
21+
run: |
22+
pip install uv
23+
uv pip install build twine
24+
25+
- name: Test SDK imports
26+
run: |
27+
python -c "import rootly_sdk; print('SDK imports successfully')"
28+
29+
- name: Build package
30+
run: |
31+
python -m build
32+
33+
- name: Publish to PyPI
34+
env:
35+
TWINE_USERNAME: __token__
36+
TWINE_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}
37+
run: |
38+
twine upload dist/*

‎LICENSE‎

Lines changed: 202 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,202 @@
1+
2+
Apache License
3+
Version 2.0, January 2004
4+
http://www.apache.org/licenses/
5+
6+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7+
8+
1. Definitions.
9+
10+
"License" shall mean the terms and conditions for use, reproduction,
11+
and distribution as defined by Sections 1 through 9 of this document.
12+
13+
"Licensor" shall mean the copyright owner or entity authorized by
14+
the copyright owner that is granting the License.
15+
16+
"Legal Entity" shall mean the union of the acting entity and all
17+
other entities that control, are controlled by, or are under common
18+
control with that entity. For the purposes of this definition,
19+
"control" means (i) the power, direct or indirect, to cause the
20+
direction or management of such entity, whether by contract or
21+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
22+
outstanding shares, or (iii) beneficial ownership of such entity.
23+
24+
"You" (or "Your") shall mean an individual or Legal Entity
25+
exercising permissions granted by this License.
26+
27+
"Source" form shall mean the preferred form for making modifications,
28+
including but not limited to software source code, documentation
29+
source, and configuration files.
30+
31+
"Object" form shall mean any form resulting from mechanical
32+
transformation or translation of a Source form, including but
33+
not limited to compiled object code, generated documentation,
34+
and conversions to other media types.
35+
36+
"Work" shall mean the work of authorship, whether in Source or
37+
Object form, made available under the License, as indicated by a
38+
copyright notice that is included in or attached to the work
39+
(an example is provided in the Appendix below).
40+
41+
"Derivative Works" shall mean any work, whether in Source or Object
42+
form, that is based on (or derived from) the Work and for which the
43+
editorial revisions, annotations, elaborations, or other modifications
44+
represent, as a whole, an original work of authorship. For the purposes
45+
of this License, Derivative Works shall not include works that remain
46+
separable from, or merely link (or bind by name) to the interfaces of,
47+
the Work and Derivative Works thereof.
48+
49+
"Contribution" shall mean any work of authorship, including
50+
the original version of the Work and any modifications or additions
51+
to that Work or Derivative Works thereof, that is intentionally
52+
submitted to Licensor for inclusion in the Work by the copyright owner
53+
or by an individual or Legal Entity authorized to submit on behalf of
54+
the copyright owner. For the purposes of this definition, "submitted"
55+
means any form of electronic, verbal, or written communication sent
56+
to the Licensor or its representatives, including but not limited to
57+
communication on electronic mailing lists, source code control systems,
58+
and issue tracking systems that are managed by, or on behalf of, the
59+
Licensor for the purpose of discussing and improving the Work, but
60+
excluding communication that is conspicuously marked or otherwise
61+
designated in writing by the copyright owner as "Not a Contribution."
62+
63+
"Contributor" shall mean Licensor and any individual or Legal Entity
64+
on behalf of whom a Contribution has been received by Licensor and
65+
subsequently incorporated within the Work.
66+
67+
2. Grant of Copyright License. Subject to the terms and conditions of
68+
this License, each Contributor hereby grants to You a perpetual,
69+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70+
copyright license to reproduce, prepare Derivative Works of,
71+
publicly display, publicly perform, sublicense, and distribute the
72+
Work and such Derivative Works in Source or Object form.
73+
74+
3. Grant of Patent License. Subject to the terms and conditions of
75+
this License, each Contributor hereby grants to You a perpetual,
76+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77+
(except as stated in this section) patent license to make, have made,
78+
use, offer to sell, sell, import, and otherwise transfer the Work,
79+
where such license applies only to those patent claims licensable
80+
by such Contributor that are necessarily infringed by their
81+
Contribution(s) alone or by combination of their Contribution(s)
82+
with the Work to which such Contribution(s) was submitted. If You
83+
institute patent litigation against any entity (including a
84+
cross-claim or counterclaim in a lawsuit) alleging that the Work
85+
or a Contribution incorporated within the Work constitutes direct
86+
or contributory patent infringement, then any patent licenses
87+
granted to You under this License for that Work shall terminate
88+
as of the date such litigation is filed.
89+
90+
4. Redistribution. You may reproduce and distribute copies of the
91+
Work or Derivative Works thereof in any medium, with or without
92+
modifications, and in Source or Object form, provided that You
93+
meet the following conditions:
94+
95+
(a) You must give any other recipients of the Work or
96+
Derivative Works a copy of this License; and
97+
98+
(b) You must cause any modified files to carry prominent notices
99+
stating that You changed the files; and
100+
101+
(c) You must retain, in the Source form of any Derivative Works
102+
that You distribute, all copyright, patent, trademark, and
103+
attribution notices from the Source form of the Work,
104+
excluding those notices that do not pertain to any part of
105+
the Derivative Works; and
106+
107+
(d) If the Work includes a "NOTICE" text file as part of its
108+
distribution, then any Derivative Works that You distribute must
109+
include a readable copy of the attribution notices contained
110+
within such NOTICE file, excluding those notices that do not
111+
pertain to any part of the Derivative Works, in at least one
112+
of the following places: within a NOTICE text file distributed
113+
as part of the Derivative Works; within the Source form or
114+
documentation, if provided along with the Derivative Works; or,
115+
within a display generated by the Derivative Works, if and
116+
wherever such third-party notices normally appear. The contents
117+
of the NOTICE file are for informational purposes only and
118+
do not modify the License. You may add Your own attribution
119+
notices within Derivative Works that You distribute, alongside
120+
or as an addendum to the NOTICE text from the Work, provided
121+
that such additional attribution notices cannot be construed
122+
as modifying the License.
123+
124+
You may add Your own copyright statement to Your modifications and
125+
may provide additional or different license terms and conditions
126+
for use, reproduction, or distribution of Your modifications, or
127+
for any such Derivative Works as a whole, provided Your use,
128+
reproduction, and distribution of the Work otherwise complies with
129+
the conditions stated in this License.
130+
131+
5. Submission of Contributions. Unless You explicitly state otherwise,
132+
any Contribution intentionally submitted for inclusion in the Work
133+
by You to the Licensor shall be under the terms and conditions of
134+
this License, without any additional terms or conditions.
135+
Notwithstanding the above, nothing herein shall supersede or modify
136+
the terms of any separate license agreement you may have executed
137+
with Licensor regarding such Contributions.
138+
139+
6. Trademarks. This License does not grant permission to use the trade
140+
names, trademarks, service marks, or product names of the Licensor,
141+
except as required for reasonable and customary use in describing the
142+
origin of the Work and reproducing the content of the NOTICE file.
143+
144+
7. Disclaimer of Warranty. Unless required by applicable law or
145+
agreed to in writing, Licensor provides the Work (and each
146+
Contributor provides its Contributions) on an "AS IS" BASIS,
147+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148+
implied, including, without limitation, any warranties or conditions
149+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150+
PARTICULAR PURPOSE. You are solely responsible for determining the
151+
appropriateness of using or redistributing the Work and assume any
152+
risks associated with Your exercise of permissions under this License.
153+
154+
8. Limitation of Liability. In no event and under no legal theory,
155+
whether in tort (including negligence), contract, or otherwise,
156+
unless required by applicable law (such as deliberate and grossly
157+
negligent acts) or agreed to in writing, shall any Contributor be
158+
liable to You for damages, including any direct, indirect, special,
159+
incidental, or consequential damages of any character arising as a
160+
result of this License or out of the use or inability to use the
161+
Work (including but not limited to damages for loss of goodwill,
162+
work stoppage, computer failure or malfunction, or any and all
163+
other commercial damages or losses), even if such Contributor
164+
has been advised of the possibility of such damages.
165+
166+
9. Accepting Warranty or Additional Liability. While redistributing
167+
the Work or Derivative Works thereof, You may choose to offer,
168+
and charge a fee for, acceptance of support, warranty, indemnity,
169+
or other liability obligations and/or rights consistent with this
170+
License. However, in accepting such obligations, You may act only
171+
on Your own behalf and on Your sole responsibility, not on behalf
172+
of any other Contributor, and only if You agree to indemnify,
173+
defend, and hold each Contributor harmless for any liability
174+
incurred by, or claims asserted against, such Contributor by reason
175+
of your accepting any such warranty or additional liability.
176+
177+
END OF TERMS AND CONDITIONS
178+
179+
APPENDIX: How to apply the Apache License to your work.
180+
181+
To apply the Apache License to your work, attach the following
182+
boilerplate notice, with the fields enclosed by brackets "[]"
183+
replaced with your own identifying information. (Don't include
184+
the brackets!) The text should be enclosed in the appropriate
185+
comment syntax for the file format. We also recommend that a
186+
file or class name and description of purpose be included on the
187+
same "printed page" as the copyright notice for easier
188+
identification within third-party archives.
189+
190+
Copyright [2025] [Rootly]
191+
192+
Licensed under the Apache License, Version 2.0 (the "License");
193+
you may not use this file except in compliance with the License.
194+
You may obtain a copy of the License at
195+
196+
http://www.apache.org/licenses/LICENSE-2.0
197+
198+
Unless required by applicable law or agreed to in writing, software
199+
distributed under the License is distributed on an "AS IS" BASIS,
200+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201+
See the License for the specific language governing permissions and
202+
limitations under the License.

0 commit comments

Comments
 (0)