-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #2 from StructifyAI/release-please--branches--main…
…--changes--next release: 0.0.1-alpha.1
- Loading branch information
Showing
11 changed files
with
180 additions
and
13 deletions.
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,31 @@ | ||
# This workflow is triggered when a GitHub release is created. | ||
# It can also be run manually to re-publish to PyPI in case it failed for some reason. | ||
# You can run this workflow by navigating to https://www.github.com/StructifyAI/new_client/actions/workflows/publish-pypi.yml | ||
name: Publish PyPI | ||
on: | ||
workflow_dispatch: | ||
|
||
release: | ||
types: [published] | ||
|
||
jobs: | ||
publish: | ||
name: publish | ||
runs-on: ubuntu-latest | ||
|
||
steps: | ||
- uses: actions/checkout@v4 | ||
|
||
- name: Install Rye | ||
run: | | ||
curl -sSf https://rye-up.com/get | bash | ||
echo "$HOME/.rye/shims" >> $GITHUB_PATH | ||
env: | ||
RYE_VERSION: 0.24.0 | ||
RYE_INSTALL_OPTION: "--yes" | ||
|
||
- name: Publish to PyPI | ||
run: | | ||
bash ./bin/publish-pypi | ||
env: | ||
PYPI_TOKEN: ${{ secrets.STRUCTIFY_PYPI_TOKEN || secrets.PYPI_TOKEN }} |
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,19 @@ | ||
name: Release Doctor | ||
on: | ||
pull_request: | ||
workflow_dispatch: | ||
|
||
jobs: | ||
release_doctor: | ||
name: release doctor | ||
runs-on: ubuntu-latest | ||
if: github.repository == 'StructifyAI/new_client' && (github.event_name == 'push' || github.event_name == 'workflow_dispatch' || startsWith(github.head_ref, 'release-please') || github.head_ref == 'next') | ||
|
||
steps: | ||
- uses: actions/checkout@v4 | ||
|
||
- name: Check release environment | ||
run: | | ||
bash ./bin/check-release-environment | ||
env: | ||
PYPI_TOKEN: ${{ secrets.STRUCTIFY_PYPI_TOKEN || secrets.PYPI_TOKEN }} |
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,3 @@ | ||
{ | ||
".": "0.0.1-alpha.1" | ||
} |
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,9 @@ | ||
# Changelog | ||
|
||
## 0.0.1-alpha.1 (2024-04-30) | ||
|
||
Full Changelog: [v0.0.1-alpha.0...v0.0.1-alpha.1](https://github.com/StructifyAI/new_client/compare/v0.0.1-alpha.0...v0.0.1-alpha.1) | ||
|
||
### Chores | ||
|
||
* go live ([#1](https://github.com/StructifyAI/new_client/issues/1)) ([c643947](https://github.com/StructifyAI/new_client/commit/c643947f348d7738e8899be9db7d7d8c789e7532)) |
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 |
---|---|---|
|
@@ -59,7 +59,7 @@ If you’d like to use the repository from source, you can either install from g | |
To install via git: | ||
|
||
```bash | ||
pip install git+ssh://[email protected]/stainless-sdks/structify/structify-python.git | ||
pip install git+ssh://[email protected]/StructifyAI/new_client.git | ||
``` | ||
|
||
Alternatively, you can build from source and install the wheel file: | ||
|
@@ -117,7 +117,7 @@ the changes aren't made through the automated pipeline, you may want to make rel | |
|
||
### Publish with a GitHub workflow | ||
|
||
You can release to package managers by using [the `Publish PyPI` GitHub action](https://www.github.com/stainless-sdks/structify/structify-python/actions/workflows/publish-pypi.yml). This requires a setup organization or repository secret to be set up. | ||
You can release to package managers by using [the `Publish PyPI` GitHub action](https://www.github.com/StructifyAI/new_client/actions/workflows/publish-pypi.yml). This requires a setup organization or repository secret to be set up. | ||
|
||
### Publish manually | ||
|
||
|
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 |
---|---|---|
|
@@ -15,8 +15,8 @@ The REST API documentation can be found [on docs.structify.com](https://docs.str | |
## Installation | ||
|
||
```sh | ||
# install from this staging repo | ||
pip install git+ssh://[email protected]/stainless-sdks/structify/structify-python.git | ||
# install from the production repo | ||
pip install git+ssh://[email protected]/StructifyAI/new_client.git | ||
``` | ||
|
||
> [!NOTE] | ||
|
@@ -204,9 +204,9 @@ server = response.parse() # get the object that `server.version()` would have r | |
print(server.version) | ||
``` | ||
|
||
These methods return an [`APIResponse`](https://github.com/stainless-sdks/tree/main/src/structify/_response.py) object. | ||
These methods return an [`APIResponse`](https://github.com/StructifyAI/new_client/tree/main/src/structify/_response.py) object. | ||
|
||
The async client returns an [`AsyncAPIResponse`](https://github.com/stainless-sdks/tree/main/src/structify/_response.py) with the same structure, the only difference being `await`able methods for reading the response content. | ||
The async client returns an [`AsyncAPIResponse`](https://github.com/StructifyAI/new_client/tree/main/src/structify/_response.py) with the same structure, the only difference being `await`able methods for reading the response content. | ||
|
||
#### `.with_streaming_response` | ||
|
||
|
@@ -294,7 +294,7 @@ This package generally follows [SemVer](https://semver.org/spec/v2.0.0.html) con | |
|
||
We take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience. | ||
|
||
We are keen for your feedback; please open an [issue](https://www.github.com/stainless-sdks/structify/structify-python/issues) with questions, bugs, or suggestions. | ||
We are keen for your feedback; please open an [issue](https://www.github.com/StructifyAI/new_client/issues) with questions, bugs, or suggestions. | ||
|
||
## Requirements | ||
|
||
|
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,32 @@ | ||
#!/usr/bin/env bash | ||
|
||
warnings=() | ||
errors=() | ||
|
||
if [ -z "${PYPI_TOKEN}" ]; then | ||
warnings+=("The STRUCTIFY_PYPI_TOKEN secret has not been set. Please set it in either this repository's secrets or your organization secrets.") | ||
fi | ||
|
||
lenWarnings=${#warnings[@]} | ||
|
||
if [[ lenWarnings -gt 0 ]]; then | ||
echo -e "Found the following warnings in the release environment:\n" | ||
|
||
for warning in "${warnings[@]}"; do | ||
echo -e "- $warning\n" | ||
done | ||
fi | ||
|
||
lenErrors=${#errors[@]} | ||
|
||
if [[ lenErrors -gt 0 ]]; then | ||
echo -e "Found the following errors in the release environment:\n" | ||
|
||
for error in "${errors[@]}"; do | ||
echo -e "- $error\n" | ||
done | ||
|
||
exit 1 | ||
fi | ||
|
||
echo "The environment is ready to push releases!" |
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
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,66 @@ | ||
{ | ||
"packages": { | ||
".": {} | ||
}, | ||
"$schema": "https://raw.githubusercontent.com/stainless-api/release-please/main/schemas/config.json", | ||
"include-v-in-tag": true, | ||
"include-component-in-tag": false, | ||
"versioning": "prerelease", | ||
"prerelease": true, | ||
"bump-minor-pre-major": true, | ||
"bump-patch-for-minor-pre-major": false, | ||
"pull-request-header": "Automated Release PR", | ||
"pull-request-title-pattern": "release: ${version}", | ||
"changelog-sections": [ | ||
{ | ||
"type": "feat", | ||
"section": "Features" | ||
}, | ||
{ | ||
"type": "fix", | ||
"section": "Bug Fixes" | ||
}, | ||
{ | ||
"type": "perf", | ||
"section": "Performance Improvements" | ||
}, | ||
{ | ||
"type": "revert", | ||
"section": "Reverts" | ||
}, | ||
{ | ||
"type": "chore", | ||
"section": "Chores" | ||
}, | ||
{ | ||
"type": "docs", | ||
"section": "Documentation" | ||
}, | ||
{ | ||
"type": "style", | ||
"section": "Styles" | ||
}, | ||
{ | ||
"type": "refactor", | ||
"section": "Refactors" | ||
}, | ||
{ | ||
"type": "test", | ||
"section": "Tests", | ||
"hidden": true | ||
}, | ||
{ | ||
"type": "build", | ||
"section": "Build System" | ||
}, | ||
{ | ||
"type": "ci", | ||
"section": "Continuous Integration", | ||
"hidden": true | ||
} | ||
], | ||
"release-type": "python", | ||
"extra-files": [ | ||
"src/structify/_version.py" | ||
] | ||
} |
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
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 |
---|---|---|
@@ -1,4 +1,4 @@ | ||
# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. | ||
|
||
__title__ = "structify" | ||
__version__ = "0.0.1-alpha.0" | ||
__version__ = "0.0.1-alpha.1" # x-release-please-version |