-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
ce9a7ed
commit b3d014a
Showing
2 changed files
with
19 additions
and
5 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 |
---|---|---|
@@ -1 +1,19 @@ | ||
[gcsim](https://github.com/genshinsim/gcsim) binary for pypi | ||
# gcsim Binary for PyPI | ||
|
||
This document provides guidelines for releasing the [gcsim](https://github.com/genshinsim/gcsim) binary to PyPI. | ||
|
||
## Release Methods | ||
|
||
There are three primary methods to release a new version of the gcsim binary to PyPI: | ||
|
||
1. **Automated Weekly Releases**: The release workflow is automatically executed every Sunday. | ||
2. **Manual Workflow Trigger**: You can manually initiate the release workflow as needed. | ||
3. **Creating a Release**: Opt to create a release through GitHub, which triggers the release process. | ||
|
||
## Important Considerations | ||
|
||
Before manually and locally publishing a release, it's crucial to run the `scripts.py` file to ensure all necessary preparations are complete. Use the following command: | ||
|
||
``` | ||
python scripts.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