-
Notifications
You must be signed in to change notification settings - Fork 76
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Set PyRTL's Python package version from
git tag
.
This avoid keeping the latest version number in two places, `pyproject.toml` and `git tag`. Simplify instructions in release/README.md. Rename some GitHub workflow jobs to clarify their purpose.
- Loading branch information
Showing
4 changed files
with
13 additions
and
17 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 |
---|---|---|
|
@@ -5,7 +5,7 @@ on: | |
- pull_request | ||
|
||
jobs: | ||
build: | ||
test: | ||
runs-on: ubuntu-latest | ||
strategy: | ||
matrix: | ||
|
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 |
---|---|---|
|
@@ -3,16 +3,18 @@ | |
# This file configures PyRTL's distribution archives, which are built and | ||
# uploaded to PyPI with GitHub actions. | ||
# | ||
# This configuration is based on the "Packaging Python Projects" tutorial at | ||
# This configuration is roughly based on the "Packaging Python Projects" | ||
# tutorial at | ||
# https://packaging.python.org/en/latest/tutorials/packaging-projects/ | ||
|
||
[build-system] | ||
requires = ["hatchling"] | ||
requires = ["hatchling", "hatch-vcs"] | ||
build-backend = "hatchling.build" | ||
|
||
[project] | ||
name = "pyrtl" | ||
version = "0.11.0rc1" | ||
# hatch-vcs determines the version number from the latest git tag. | ||
dynamic = ["version"] | ||
authors = [ | ||
{name="Timothy Sherwood", email="[email protected]"}, | ||
{name="John Clow"}, | ||
|
@@ -46,3 +48,6 @@ svg = ["graphviz"] | |
Homepage = "http://ucsbarchlab.github.io/PyRTL/" | ||
GitHub = "https://github.com/UCSBarchlab/PyRTL" | ||
Documentation = "https://pyrtl.readthedocs.io/" | ||
|
||
[tool.hatch.version] | ||
source = "vcs" |
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 |
---|---|---|
|
@@ -38,17 +38,11 @@ numbers. | |
$ git clone [email protected]:UCSBarchlab/PyRTL.git pyrtl | ||
$ cd pyrtl | ||
``` | ||
2. Edit `pyproject.toml` by updating the `version =` line to `version = | ||
"$NEW_VERSION"` | ||
3. Commit this change: | ||
```shell | ||
$ git commit pyproject.toml | ||
``` | ||
4. Tag the new version: | ||
2. Tag the new version: | ||
```shell | ||
$ git tag $NEW_VERSION | ||
``` | ||
5. Push this change to GitHub. Tags are not pushed by default, so use: | ||
3. Push this change to GitHub. Tags are not pushed by default, so use: | ||
```shell | ||
$ git push origin $NEW_VERSION | ||
``` | ||
|