Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Issue-112] Automatically extract rohd version from pubspec to add into generated sv #200

Merged
merged 14 commits into from
Dec 5, 2022

Conversation

quekyj
Copy link
Contributor

@quekyj quekyj commented Nov 16, 2022

Description & Motivation

It would be nice if the generated outputs (e.g. SystemVerilog, waveform dumps) had a guaranteed accurate version number of ROHD that generated them. A version number (from pubspec.yaml) would be good, but even better would be to also include a git hash, so it can be determined exactly what generated the code.

Related Issue(s)

issue #112

Testing

Add test to expect the rohd version and git commit are available in the generated system verilog code generation.

Backwards-compatibility

Is this a breaking change that will not be backwards-compatible? If yes, how so?

no.

Documentation

Does the change require any updates to documentation? If so, where? Are they included?

Ya, added to each of the file created.

pubspec.yaml Outdated Show resolved Hide resolved
@mkorbel1
Copy link
Contributor

If we create a (pre-)release script, a couple things it can do:

  • Update some file with the current git hash
  • Confirm that the version in pubspec.yaml matches the version in Config

@quekyj
Copy link
Contributor Author

quekyj commented Nov 24, 2022

Write a unit test to check for pubspec.yaml and the one in config.

@quekyj
Copy link
Contributor Author

quekyj commented Nov 24, 2022

Omit the hash part, too complicated to implement.

pubspec.yaml Outdated Show resolved Hide resolved
lib/src/module.dart Show resolved Hide resolved
@quekyj quekyj requested a review from mkorbel1 November 28, 2022 02:10
lib/src/wave_dumper.dart Show resolved Hide resolved
lib/src/utilities/config.dart Outdated Show resolved Hide resolved
test/config_test.dart Outdated Show resolved Hide resolved
@quekyj quekyj requested a review from mkorbel1 December 1, 2022 03:07
test/config_test.dart Outdated Show resolved Hide resolved
@quekyj quekyj requested a review from mkorbel1 December 2, 2022 00:56
Copy link
Contributor

@mkorbel1 mkorbel1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good!

@mkorbel1 mkorbel1 linked an issue Dec 5, 2022 that may be closed by this pull request
@mkorbel1 mkorbel1 merged commit 4ea39a2 into intel:main Dec 5, 2022
@quekyj quekyj deleted the 112-automatically-extract-rohd-version branch December 16, 2022 06:48
quekyj added a commit to quekyj/rohd that referenced this pull request Jan 9, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Automatically extract/update the version of ROHD that generates things
2 participants