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

[evol] Add a new report type FullHTML + Add the parameter includeOnly… #44

Closed
wants to merge 5 commits into from

Conversation

edahenit
Copy link

@edahenit edahenit commented Feb 17, 2017

Hello Daniel,

Following our exchange Layout report HTML : evolution #37

  • I added a new type of html report with options generateFullHTMLChangeLog and fullHTMLChangeLogFilename :
    gitlog

  • I added the option includeOnlyCommitsAfterRelease allows to generate only the commits of the last release

  • I added the new goal install to install the report in the local repository of Maven.

I propose to integrate in the next version.

import org.apache.maven.plugins.annotations.Parameter;

/**
* install the report in the local repository.
Copy link
Owner

Choose a reason for hiding this comment

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

Can you explain a bit more what this is and why someone would do this? Is it something like... it can include the changelog in the files it uploads to Nexus? Or is it something else...

Copy link
Author

Choose a reason for hiding this comment

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

Hello,
Thank you for your reply.
yes, it can include the changelog in the files it uploads to Nexus with classifier "report".

private boolean includeOnlyCommitsAfterRelease;

/**
* the tag name of release
Copy link
Owner

Choose a reason for hiding this comment

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

Can you explain a bit more about this option? Is it the prefix of that tag name, or a git commit, that marks a commit as a release?

Copy link
Author

Choose a reason for hiding this comment

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

the option includeOnlyCommitsAfterRelease allows to generate only the commits of the last release.
If includeOnlyCommitsAfterRelease is true the generated report contains only the commits after the last delivery.
If option X is false the generated report contains all the commits of the branch.
Example configuration :
maven-gitlog-pluginpom xml at master edahenitmaven-gitlog-plugin - google chrome

This diagram explains the case where the option includeOnlyCommitsAfterRelease is true :
microsoft powerpoint - gitlog pptm

@danielflower
Copy link
Owner

Thanks for the update. Aside from the questions I added inline, there are a couple more things:

  • Can you update the samples in src/site/resources/samples
  • Can you update the documentation in src/site/markdown/usage.md.vm to show the new option, and also explain the new goal.
  • Can you bump the version number? Maybe it should be a major version change, i.e. change to 2.0-SNAPSHOT as it's kind of a breaking change in that the default rendering is changing.

@edahenit edahenit closed this by deleting the head repository Jul 12, 2024
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.

2 participants