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

Question about the generated requirement artifact, #22

Open
fabianbuettner opened this issue Oct 15, 2018 · 4 comments
Open

Question about the generated requirement artifact, #22

fabianbuettner opened this issue Oct 15, 2018 · 4 comments

Comments

@fabianbuettner
Copy link

Hi,

after fixing some initial problems with my pip installation of rmtoo, I was able to play around with rmtoo.
Something what I could not solve was that string in the footer of the generated requirement artifact: "Version Commit [None] VCS Id [topics]"

I was wondering about how I am supposed to change the "Version Commit" and what is the "VCS Id" supposed to be?

regards,
Fabian

@florath
Copy link
Owner

florath commented Oct 16, 2018

The version output is defined as 'Commit [%s] VCS Id [%s]' where the first is the commit id and the second the top level of the topics used for this output document. When using git the first is the git hash.
Some output modules (like version1) use the string. (With rmtoo you can e.g. have different outputs of one set of input files, e.g. one PDF for internal use with all input and one PDF that includes only a subset of the input which can be sent to a customer or vendor. To uniquely mark them, those both infos are needed.)

I'm not really sure what you mean with 'who to change this'?

If you don't want this, do not use the appropriate output modules.
To 'change' the commit, you have to use e.g. git and in this case always the latest git hash is used.
The VCS Id can be 'changed' by using a different top node of the topic tree.

@fabianbuettner
Copy link
Author

fabianbuettner commented Oct 16, 2018

Hi,
thanks for the reply.

Is there a example about how to generate different outputs of one set of inputs?

I'm not really sure what you mean with 'who to change this'?

I searched through the code and I could not find out where this 'Commit [%s] VCS Id [%s]' string was coming from and how that placeholder values %s are getting replaced.

Which files of the template project do I have to commit to get the commit string replaced by the git hash?

VCS Id string can be changed by changing the location of the topic directory, I assume? What does the abbreviation 'VCS' mean in this context?

regards,
Fabian

@florath
Copy link
Owner

florath commented Oct 16, 2018

Is there a example about how to generate different outputs of one set of inputs?
You need to define two separate Config.json files and call rmtoo for each of the config.

I searched through the code and I could not find out where this 'Commit [%s] VCS Id [%s]' string was coming from and how that placeholder values %s are getting replaced.
It's from rmtoo/lib/vcs/CommitInfo.py

Which files of the template project do I have to commit to get the commit string replaced by the git hash?
The idea is: all that are needed as input.

VCS Id string can be changed by changing the location of the topic directory, I assume?
Yes - I also assume this. ;-)

What does the abbreviation 'VCS' mean in this context?
Version Control System

@fabianbuettner
Copy link
Author

Ok i think i should have taken a closer look at the man pages.

Which files of the template project do I have to commit to get the commit string replaced >by the git hash?
The idea is: all that are needed as input.

Ok, I had forgotten to change the Config.json topics/ts_common/sources array to "git".
After calling rmtoo, I get the following output in my requirements.pdf(using the hashes from the git log as start_vers and end_vers):

Version Commit [24260b5e19687d285e43ac553ab711121a0c6648] VCS Id
[bd901c868a2d5f915a54a9b4e29cd7621f6d8d07]

Is this correct?

If there is only one commit in my git repository. I cannot get rmtoo to generate a requirements.pdf

Thanks for your help!

Where should I post, when I have got more question?

regards,
Fabian

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

No branches or pull requests

2 participants