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

Deploy github site using maven-scm-publish plugin 🏗️ #532

Merged
merged 2 commits into from
Nov 18, 2024

Conversation

ivy-rew
Copy link
Member

@ivy-rew ivy-rew commented Nov 15, 2024

first approach that works without e-git; here to gather (your 😉 ) early feedback @alexsuter

@ivy-rew ivy-rew force-pushed the siteDeployV2 branch 30 times, most recently from ba72267 to d84ae6f Compare November 15, 2024 16:42
@ivy-rew ivy-rew force-pushed the siteDeployV2 branch 3 times, most recently from eced40d to bb27559 Compare November 15, 2024 16:48
Jenkinsfile Outdated Show resolved Hide resolved
Jenkinsfile Show resolved Hide resolved
@ivy-rew ivy-rew requested a review from alexsuter November 15, 2024 17:02
Copy link
Member

@alexsuter alexsuter left a comment

Choose a reason for hiding this comment

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

@ivy-rew
Copy link
Member Author

ivy-rew commented Nov 18, 2024

I think something like this looks easier: https://www.lorenzobettini.it/2020/01/publishing-a-maven-site-to-github-pages/

definitively promising, thanks for sharing. I'll try this approach.

Comment on lines -15 to -18
booleanParam(name: 'skipGitHubSite',
description: 'If checked the plugin documentation on GitHub will NOT be updated',
defaultValue: true)

Copy link
Member Author

Choose a reason for hiding this comment

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

I think this one of the reasons why the release pipeline tends to fail: ... we did not automatically run github sites creation (due to its slow runtime with egit).
Now we will update the snapshot docs on every nightly, which is what we want I think

git config --global user.name 'ivy-team'
git config --global user.email '[email protected]'
"""
maven cmd: "site site:stage scm-publish:publish-scm"
Copy link
Member Author

Choose a reason for hiding this comment

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

ci: also generates the site ... just before deploying

@@ -41,6 +41,8 @@ pipeline {
sh "gh auth login --with-token < ${tokenFile}"
sh "gh pr create --title '${message}' --body '${message}' --head ${targetBranch} --base ${env.BRANCH_NAME}"
}
// publish site from 'mvn release' run
maven cmd: "site:stage scm-publish:publish-scm"
Copy link
Member Author

Choose a reason for hiding this comment

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

no site generation (would be in wrong mode -> next snapshot).
I think the generated site from release-profile should still exist and be re-usable for publishing (but hard to test without actually running a release :)

@@ -349,7 +333,7 @@
<configuration>
<tagNameFormat>v@{project.version}</tagNameFormat>
<releaseProfiles>release</releaseProfiles>
<goals>deploy site-deploy</goals>
<goals>deploy site</goals>
Copy link
Member Author

Choose a reason for hiding this comment

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

the actual xhtml generation when running a release.

@ivy-rew ivy-rew marked this pull request as ready for review November 18, 2024 10:44
@ivy-rew
Copy link
Member Author

ivy-rew commented Nov 18, 2024

here's a sample site publish commit: provided by scm-publish:publish-scm (though run on my local cli)

f500991

Copy link
Member

@alexsuter alexsuter left a comment

Choose a reason for hiding this comment

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

much better 👍

@ivy-rew ivy-rew changed the title Site deploy v2 🏗️ Deploy github site using maven-scm-publish plugin 🏗️ Nov 18, 2024
@ivy-rew ivy-rew merged commit 3bb35d5 into master Nov 18, 2024
3 of 4 checks passed
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