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

Release workflow #282

Merged
merged 5 commits into from
Nov 10, 2023
Merged

Release workflow #282

merged 5 commits into from
Nov 10, 2023

Conversation

magnusbechwind
Copy link
Contributor

@magnusbechwind magnusbechwind commented Nov 3, 2023

Purpose

Adds a workflow automatically compiling native dependencies and attaching a jar with the dependencies embedded to new releases when created. Also generates javadoc both as a .jar attached to the release and as a "site" deployed to https://concordium.github.io/concordium-java-sdk/javadoc/concordium-sdk/apidocs/

Result of release demonstrated as release in https://github.com/magnusbechwind/concordium-java-sdk/releases/tag/v.5.1.2

Changes

Added workflow and updated the pom

In addition to the proposed changes, the settings/pages should be changed to the following to enable deplayment of javadoc
image

Checklist

  • My code follows the style of this project.
  • The code compiles without warnings.
  • I have performed a self-review of the changes.
  • I have documented my code, in particular the intent of the
    hard-to-understand areas.
  • (If necessary) I have updated the CHANGELOG.

@magnusbechwind magnusbechwind marked this pull request as ready for review November 3, 2023 12:28
@magnusbechwind magnusbechwind changed the title Create release.yml Release workflow Nov 3, 2023
Copy link
Contributor

@MilkywayPirate MilkywayPirate left a comment

Choose a reason for hiding this comment

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

Please add a description of the flow here https://github.com/Concordium/concordium-java-sdk/tree/main/release

together with some explanation of how javadoc is generated.

.github/workflows/release.yml Outdated Show resolved Hide resolved
Copy link
Contributor

@MilkywayPirate MilkywayPirate left a comment

Choose a reason for hiding this comment

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

Looks great! Let's give it a spin soon.

@magnusbechwind magnusbechwind merged commit b7ed405 into main Nov 10, 2023
1 check passed
@magnusbechwind magnusbechwind deleted the release-workflow branch November 10, 2023 14:11
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.

Supply documentation with sdk Generate documentation and link it Release and CI integration
2 participants