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

Configurable deployment #125

Merged
merged 6 commits into from
Jun 29, 2023

Conversation

kommendorkapten
Copy link
Collaborator

Closes #122

The version bump and snapshot composite actions are now updated to accept two new parameters:

  • metadata_path: the path inside the publish directory for the metadata, default is /, ie the root of the publish directory
  • targets_path: the path inside the publish directory for the targets, default is targets.

The parameters are provided to the publish method which makes sure to publish the metadata and targets accordingly, and then the final artifact is uploaded to pages.

@kommendorkapten
Copy link
Collaborator Author

See jku/playground-template#2

@kommendorkapten
Copy link
Collaborator Author

For backwards compatibility do we want to have default metadata path to metadata to avoid any braking change? I opted / more as an example of how to set it to the root. The template still uses metadata for the metadata directory.

metadata_path:
description: 'Path where to store the metadata files in the published repository'
required: true
default: '/'
Copy link
Owner

Choose a reason for hiding this comment

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

I think I would prefer "metadata" as the default -- I think combining the directories like this does (so that targets dir is inside the metadata dir) has more potential for issues and I do not think we should recommend that

Copy link
Owner

Choose a reason for hiding this comment

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

wait, this has both "required" and "default" -- does that make sense?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Yeah, let me remove the default values. They are set in the workflows in the template repository.

Copy link
Owner

@jku jku left a comment

Choose a reason for hiding this comment

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

LGTM:

  • I think metadata and targets should go to separate directories by default but that's just mild preference (since the workflow sets it anyway)
  • long term we should separate publishing directories from the directories used in online-version-bump and snapshot... but I think we have an issue for that already

@kommendorkapten
Copy link
Collaborator Author

long term we should separate publishing directories from the directories used in online-version-bump and snapshot... but I think we have an issue for that already

You are referring this this issue, right: #126

@kommendorkapten kommendorkapten merged commit b7a2f95 into jku:main Jun 29, 2023
@kommendorkapten kommendorkapten deleted the configurable-deployment branch June 29, 2023 08:32
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.

publish: repository should have complete control over URLs
2 participants