[setup] Bump fallback version #6
Merged
Conversation
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
When installing FuseSoC from OpenTitan -- that is, with
pip install -r python-requirements.txt
Pip currently gets instructed to download
https://github.com/lowRISC/fusesoc/archive/refs/tags/ot-0.5.zip
However, that downloaded version **currently presents itself as version
`0.4.dev0`**, to Pip as well as in `fusesoc --version`. This is
problematic in at least two ways:
1. Because Pip gets told that it downloaded version 0.4, it can prefer
to use a locally cached archive (and I've seen it doing that!) that
is *really* version 0.4, causing the update to fail even though the
user thinks they just updated FuseSoC.
2. Users have no way of distinguishing between versions 0.4 and 0.5 from
the command line, which makes debugging difficult.
I don't know the root cause for why `use_scm_version` doesn't work as
expected, but this hotfixes the fallback version to the currently tagged
version. We then need to update the Git tag to this commit and update
the hash in the OpenTitan repo.
|
If we could release a tarball that has the build results from the git repo (instead of just the source), then the version would be filled in during the build step. |
andreaskurth
added a commit
to andreaskurth/opentitan
that referenced
this pull request
Mar 21, 2024
Prior to this commit, the FuseSoC version downloaded when running
pip install -r python-requirements.txt
would identify itself as **version `0.4.dev0`** to Pip as well as in
`fusesoc --version`. This is problematic in at least two ways:
1. Because Pip gets told that it downloaded version 0.4, it can prefer
to use a locally cached archive (and I've seen it doing that!) that
is *really* version 0.4, causing the update to become a NOP even
though the user thinks they just updated FuseSoC.
2. Users have no way of distinguishing between versions 0.4 and 0.5 from
the command line, which makes debugging issues that got fixed in
version 0.5 difficult.
To work around this problem, the PR lowRISC/fusesoc#6 changed
`fallback_version`, from which our FuseSoC gets its version, to
`0.5.dev0`, and this version was subsequently tagged as such. This
commit now updates our Python requirements to load the fixed version.
Run `pip install -r python-requirements.txt` after this commit has
landed to update FuseSoC to version `0.5.dev0` for good.
Signed-off-by: Andreas Kurth <[email protected]>
andreaskurth
added a commit
to lowRISC/opentitan
that referenced
this pull request
Mar 22, 2024
Prior to this commit, the FuseSoC version downloaded when running
pip install -r python-requirements.txt
would identify itself as **version `0.4.dev0`** to Pip as well as in
`fusesoc --version`. This is problematic in at least two ways:
1. Because Pip gets told that it downloaded version 0.4, it can prefer
to use a locally cached archive (and I've seen it doing that!) that
is *really* version 0.4, causing the update to become a NOP even
though the user thinks they just updated FuseSoC.
2. Users have no way of distinguishing between versions 0.4 and 0.5 from
the command line, which makes debugging issues that got fixed in
version 0.5 difficult.
To work around this problem, the PR lowRISC/fusesoc#6 changed
`fallback_version`, from which our FuseSoC gets its version, to
`0.5.dev0`, and this version was subsequently tagged as such. This
commit now updates our Python requirements to load the fixed version.
Run `pip install -r python-requirements.txt` after this commit has
landed to update FuseSoC to version `0.5.dev0` for good.
Signed-off-by: Andreas Kurth <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
When installing FuseSoC from OpenTitan -- that is, with
Pip currently gets instructed to download
However, that downloaded version currently presents itself as version
0.4.dev0, to Pip as well as infusesoc --version. This is problematic in at least two ways:Because Pip gets told that it downloaded version 0.4, it can prefer to use a locally cached archive (and I've seen it doing that!) that is really version 0.4, causing the update to become a NOP even though the user thinks they just updated FuseSoC.
Users have no way of distinguishing between versions 0.4 and 0.5 from the command line, which makes debugging difficult.
I don't know the root cause for why
use_scm_versiondoesn't work as expected, but this hotfixes the fallback version to the currently tagged version. We then need to update the Git tag to this commit and update the hash in the OpenTitan repo.