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

Introduce versioning of the sofware #155

Open
nichtich opened this issue Nov 21, 2023 · 2 comments
Open

Introduce versioning of the sofware #155

nichtich opened this issue Nov 21, 2023 · 2 comments
Assignees

Comments

@nichtich
Copy link
Collaborator

As discussed at #142 (comment) every change to the main branch should result in a new version number (git tag). Questions to decide on:

  1. how to name tags vX.y.Z or X.Y.Z
  2. whether to also support pre-releases (I don't like them, this makes things more complicated)
  3. how to display the version number on the UI (it's only available as git tag)

For 3, a script like this would help:

TAG=$(git tag --points-at HEAD | head -1)
BRANCH=$(git rev-parse --abbrev-ref HEAD)
CLEAN=$(git diff --quiet && echo ok)
COMMIT=$(git rev-parse HEAD)

This information could be written into a local file and read to be displayed in the UI.

@nichtich nichtich self-assigned this Nov 21, 2023
@pkiraly
Copy link
Owner

pkiraly commented Nov 21, 2023

  1. So far we added 'v' to version number, so the pattern I would prefer is vX.Y.Z.
  2. in the backend the release process is a bit complicated, and I test the steps with preleases. For the UI it is not so important.
  3. I attach a screenshot from Dataverse. It is displayed at the bottom of the page.
    Screenshot from 2023-11-21 16-52-33.
    There is a mechanism in Maven to export these info during the building process.

@nichtich
Copy link
Collaborator Author

The develop branch now contains functionality to show version number (current git tag) or branch and commit in the footer, please try out for testing. If the application is served as www-data or from Docker, the direct access to git will likely not work (see install note in README.md). In this case the data is read from local file version.ini, created by composer version (automatically called after composer install and as part of composer release). For releasing, the version number has to be set manually with git tag.

This should craft a new release from current develop branch, with version number:

git tag v0.7.1; composer release

Without tagging, the branch and commit hash is shown instead.

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

No branches or pull requests

2 participants