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

Deliverables: as downloadable package or linked to a specific commit? #346

Open
AsamDiegoSanchez opened this issue Jan 30, 2025 · 5 comments
Assignees
Labels
isType:Feature An issue that adds new features to the project.
Milestone

Comments

@AsamDiegoSanchez
Copy link
Member

Is your feature request related to a problem? Please describe.

Right now we have the deliverable as links to the OpenMATERIAL 3D repository.

Image

Describe the solution you'd like

I want to explore the following 2 options:

a) that we offer a downloadable package (similar to OpenDRIVE)

Image

b) that we keep using links, but should point to a specific commit or tag (like the official release)

What do you think?

@AsamDiegoSanchez AsamDiegoSanchez added the isType:Feature An issue that adds new features to the project. label Jan 30, 2025
@AsamDiegoSanchez AsamDiegoSanchez added this to the v1.0.0 milestone Jan 30, 2025
@LudwigFriedmann
Copy link
Collaborator

I'd suggest to create a release package.

@ClemensLinnhoff
Copy link
Collaborator

I would not put a download package in the documentation. In my opinion this is only used in OpenDRIVE, because it is not an open-source development. All our sources here are freely available.

So I would stick to links. You are right, we can put the release tag of the version in the link. But this can only be done very shortly before the actual release. Otherwise the links will be broken for a longer time. It is kind of a hen and egg problem. The links need to be correct in the release, but they can only be correct, after the release tag has been set.

@LudwigFriedmann
Copy link
Collaborator

But wouldn't it make the most sense to create a tag on the day of the TSC and create a release package 1.0 from it, which is then linked to from the documentation?

@ClemensLinnhoff
Copy link
Collaborator

But wouldn't it make the most sense to create a tag on the day of the TSC and create a release package 1.0 from it, which is then linked to from the documentation?

Yes, but you need to create the links first, then create the tag. Otherwise the correct links are not part of the tagged commit.

@LudwigFriedmann
Copy link
Collaborator

LudwigFriedmann commented Feb 3, 2025

Yes, of course, the links would be invalid until the release is published. I'd therefore integrate them into the documentation shortly before the release and then create the tag and the release package from that tag.

The link can be specified as soon as we now how we want to name our release tag, see the link to the most recent esmini release : https://github.com/esmini/esmini/releases/tag/v2.45.1

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
isType:Feature An issue that adds new features to the project.
Projects
None yet
Development

No branches or pull requests

6 participants