Skip to content

Rework Antora Gradle Infrastructure #40572

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

Closed
wilkinsona opened this issue Apr 29, 2024 · 4 comments
Closed

Rework Antora Gradle Infrastructure #40572

wilkinsona opened this issue Apr 29, 2024 · 4 comments
Assignees
Labels
type: task A general task
Milestone

Comments

@wilkinsona
Copy link
Member

Many of the task's inputs are currently captured in a Map<String, Object>. When comparing build scans this makes it hard to determine why the task was or was not up-to-date. data is represented as a Value property. When the value differs, all that we're shown is that "Input 'data' is in both builds but values are different". Splitting this input up into several more finely grained inputs will make build scans more useful.

@wilkinsona wilkinsona added the type: task A general task label Apr 29, 2024
@wilkinsona wilkinsona added this to the 3.3.x milestone Apr 29, 2024
@scottfrederick scottfrederick self-assigned this May 6, 2024
@philwebb
Copy link
Member

It looks like getAlwaysInclude is the only MapProperty and it is only ever called with a name and classifier. @wilkinsona Do we have another example where we've done this? I think ideally I'd rather not have two properties, perhaps we can use a record?

@wilkinsona
Copy link
Member Author

It's the data input that's the biggest concern:

@Input
final Map<String, Object> getData() throws IOException {
Map<String, Object> data = loadPlaybookTemplate();
addExtensions(data);
addSources(data);
addDir(data);
filterJavadocExtension(data);
return data;
}

@philwebb
Copy link
Member

I wonder if we can drop @Input from that one. It seems like it's built up from other properties.

philwebb added a commit that referenced this issue Oct 22, 2024
Remove `@Input` from the `getData()` method since it's built up from
other properties.

See gh-40572
philwebb added a commit that referenced this issue Oct 23, 2024
This reverts commit a9e50d6 as
we do have some undeclared inputs.

See gh-40572
@wilkinsona
Copy link
Member Author

I'd like to expand this to cover a couple of other things that have been tackled elsewhere for other tasks:

@wilkinsona wilkinsona changed the title Declare the inputs of GenerateAntoraPlaybook more precisely Rework GenerateAntoraPlaybook Oct 29, 2024
@wilkinsona wilkinsona self-assigned this Oct 29, 2024
@wilkinsona wilkinsona changed the title Rework GenerateAntoraPlaybook Rework Antora Gradle Infrastructure Nov 1, 2024
@wilkinsona wilkinsona modified the milestones: 3.3.x, 3.3.6 Nov 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: task A general task
Projects
None yet
Development

No branches or pull requests

3 participants