-
Notifications
You must be signed in to change notification settings - Fork 2
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
fc58bad
commit fc6aaab
Showing
6 changed files
with
23 additions
and
18 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
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,8 +1,13 @@ | ||
# Release Instructions | ||
|
||
**REPLACE:** How does one generate a new release of the software? Ideally, this | ||
should be an automated process, but there may still be a handful of steps. It is | ||
also good to describe, at a high level, what the release script does. For | ||
example, create a Git tag, increment the version number in a particular file, | ||
create a release on GitHub, and so on. | ||
DIPLOMAT is setup to be easy to release, using Github-Actions. To release a new DIPLOMAT version, the following | ||
steps can be followed. | ||
1. Update `RELEASE_NOTES.md` to list the latest features in DIPLOMAT. | ||
2. Modify DIPLOMAT's `__init__.py` file (located at `diplomat/__init__.py`) to increase the version number. | ||
This is done by modifying the `__version__` variable in the file to a new semver, such as `"1.0.1"`. | ||
3. Commit your changes, and push them to the `main` branch. This can be done by: | ||
- Manually pushing to the main branch. | ||
- Creating, and merging a GitHub Pull-Request. | ||
|
||
Once done, the GitHub action hooks will automatically detect the new version change, and create a new pypi version | ||
and release on GitHub (including a tag for the version). |
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
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