[docs] Add Firtool versions table to Versioning page #3694
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
jackkoenig
commented
Dec 19, 2023
Comment on lines
+463
to
+481
| .settings( | ||
| firtoolVersionsTableTask / fileInputs ++= { | ||
| val rootGlob = (root / baseDirectory).value.toGlob | ||
| Seq(rootGlob / "build.sbt", rootGlob / "project" / "*.sbt", rootGlob / "project" / "*.scala") | ||
| }, | ||
| firtoolVersionsTableTask := { | ||
| val logger = streams.value.log | ||
| val file = (Compile / sourceManaged).value / "FirtoolVersionsTable.scala" | ||
| // Only write the file if an input has changed | ||
| if (!file.exists || firtoolVersionsTableTask.inputFileChanges.hasChanges) { | ||
| // Escaping newlines makes it easier to generate the file | ||
| val table = FirtoolVersionsTable.generateTable.replaceAll("\n", "\\\\n") | ||
| logger.info(s"Writing $file...") | ||
| IO.write(file, s"""object FirtoolVersionsTable { def table = "$table" }""") | ||
| } | ||
| Seq(file) | ||
| }, | ||
| Compile / sourceGenerators += firtoolVersionsTableTask.taskValue | ||
| ) |
There was a problem hiding this comment.
This also illustrates how to generate files in SBT and have it properly track dependencies, was a bit frustrating to figure out but not bad once you have it working.
jackkoenig
force-pushed
the
firtool-versions-table
branch
from
f4c9a14
to
7268dd0
Compare
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.
Fixes #3669
Contributor Checklist
docs/src?Type of Improvement
Desired Merge Strategy
Release Notes
This table is generated for all versions of Chisel that include
BuildInfo.firtoolVersionand will thus automatically include new releases. Versions of Chisel that predateBuildInfo.firtoolVersionare included in the table manually.Reviewer Checklist (only modified by reviewer)
3.5.x,3.6.x, or5.xdepending on impact, API modification or big change:6.0)?Enable auto-merge (squash), clean up the commit message, and label withPlease Merge.Create a merge commit.