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

Update version number on the Validate page #230

Merged
merged 2 commits into from
Nov 20, 2023
Merged

Conversation

isabelle-dr
Copy link
Contributor

@isabelle-dr isabelle-dr commented Nov 16, 2023

Removed the version number from this page so that we don't have to manually change it every time we have a release.
The link to the latest release notes stays.

cc @jcpitre

@isabelle-dr isabelle-dr requested a review from emmambd November 16, 2023 12:51
@isabelle-dr
Copy link
Contributor Author

Also @fredericsimard (now that you're looking at our translation processes) and @emmambd:
For the time being, is it easier to make the change on all the other translated pages in each PR (meaning I'd update all the other pages here), or to wait for a bigger update?
We could add a requirement that before we merge each PR we update all translations. Let me know what you think.

@emmambd
Copy link
Contributor

emmambd commented Nov 16, 2023

@isabelle-dr For translation maintenance, I'd recommend that it's simpler doing it before the PR's merged.

@derhuerst
Copy link

derhuerst commented Nov 16, 2023

My 2 cents:
I think it would be very valuable to know which version of the GTFS validator is actually deployed!
(Following this need, it would also make sense not to link to the latest release, but the deployed one. There's almost nothing more confusing – especially for less experienced users – to assume that one is running with a version that one actually isn't.)

@isabelle-dr
Copy link
Contributor Author

Thank you @derhuerst !

Let's keep the version number then. I've opened a PR to add this step to our validator release documentation so we don't forget.

I was assuming that we were deploying as part of making a release, which would mean that latest release version and deployed version were the same at all times.
I don't see anything about this in validator release documentation.
@jcpitre is this an accurate assumption or are we doing something different?

@derhuerst, the report also displays the version (see below). And it's the latest currently 🙂
Screenshot 2023-11-16 at 10 14 18 AM

@emmambd emmambd requested a review from jcpitre November 16, 2023 18:31
@jcpitre
Copy link
Contributor

jcpitre commented Nov 16, 2023

@derhuerst Currently the executable downloads, the jars and the web validator are all at 4.2.0
Is there anything else where the version should be upgraded?

But you do make a good point. We need to be more transparent on the version that is running, so I think the web version should display the validator version (not just in the report) and docs/schedule/validate.md should not have to be updated manually (maybe it can display the current version from a https://github.com/MobilityData/gtfs-validator/wiki/Current-Version?)

@derhuerst
Copy link

But you do make a good point. We need to be more transparent on the version that is running, so I think the web version should display the validator version (not just in the report) and docs/schedule/validate.md should not have to be updated manually (maybe it can display the current version from a https://github.com/MobilityData/gtfs-validator/wiki/Current-Version?)

We might have a misunderstanding here: I want the currently running version to be displayed in both the validation form and the report. It should be taken from the deployed code (executable, jar or Docker image) itself. This is especially help when I want to archive historical reports.

Displaying whatever is the latest available version is interesting, but of secondary importance to me, given that I can always look that information up manually. (Or set up some auto-update, e.g. using Dependabot & the Docker image.)

@isabelle-dr isabelle-dr changed the title Remove version number from the Validate page Update version number on the Validate page Nov 20, 2023
@isabelle-dr
Copy link
Contributor Author

Merging this PR since the version number has been updated.

From the conversation here, I opened two follow-up issues:

Also, I've added this PR to the translation backlog.

Thank you @derhuerst 🙏

@isabelle-dr isabelle-dr merged commit e8206c4 into main Nov 20, 2023
@isabelle-dr isabelle-dr deleted the update-validate-page branch November 20, 2023 19:28
@jcpitre
Copy link
Contributor

jcpitre commented Nov 22, 2023

@derhuerst:

We might have a misunderstanding here: I want the currently running version to be displayed in both the validation form and the report. It should be taken from the deployed code (executable, jar or Docker image) itself. This is especially help when I want to archive historical reports.

My comment presupposed that the version used by the web validator is the latest one as found in the Current-Version file.
But I agree that it's always better to go back to the source and extract it from the actual code.

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.

5 participants