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

Add: 'Developer Files' section on download pages #111

Merged
merged 1 commit into from Nov 23, 2019
Merged

Conversation

@glx22
Copy link
Contributor

glx22 commented Nov 4, 2019

I don't really know how the website works, but I think it would be nice to have an easy access to pdb files. I hope this change is enough.

@LordAro
Copy link
Member

LordAro commented Nov 4, 2019

Alas, it is not. As best as I can tell, PDB files are not currently distributed at all (they don't appear in the manifest files at (e.g.) https://proxy.binaries.openttd.org/openttd-releases/1.10.0-beta1/manifest.yaml )

I'm not sure they're even built in the CI currently, you'd need to check yourself -
https://github.com/OpenTTD/OpenTTD/blob/2be619ea88837c6293129841511816c105b507a3/azure-pipelines/templates/release.yml#L67-L103

But they're certainly excluded from the manifest generation script - https://github.com/OpenTTD/OpenTTD/blob/2be619ea88837c6293129841511816c105b507a3/azure-pipelines/manifest.sh#L41
You'd have to ask @TrueBrain why that is...

@glx22
Copy link
Contributor Author

glx22 commented Nov 4, 2019

If I copy the openttd-<version>-windows-win64.exe URI and replace exe with pdb.xz I can download it. But indeed maybe website itself doesn't know they exist.

@TrueBrain
Copy link
Member

TrueBrain commented Nov 4, 2019

Your patch won't do what you think it does :) pdb, as dbg.deb are on the ignore list when generating the manifest, which is needed to generate URLs.

They are on the ignore list, because people kept downloading them. That is, 30% of the people who downloaded the zip or exe also downloaded the pdb. Because people don't know what it is for.

So I am very much against putting them in the download list, with the other files. History shows that it is a bad solution :)

What might work, is some redesigning, where we put this in a new part on the downloads page, something like "Debug files" or what-ever. Here we can list the pdb and dbg.deb files.

Either way, if you make a PR for this repository, please create and run the docker to check if it fixes what you think it does :) It is the whole reason this is a Docker .. so you can try it out on your local machine too :P Saves you going back and forth with assumptions :D

Going to close this PR for now; as what-ever solution we pick, it should be looking different :D Please do invest time in it, as it is worth fixing this properly!

PS: yes, pdb and dbg.deb are published on the CDN, and if you know the URL, are free to download :)

@TrueBrain TrueBrain closed this Nov 4, 2019
@nielsmh
Copy link
Contributor

nielsmh commented Nov 5, 2019

Make it a "Tools for developers (not required to play the game)" download section, that also has grfcodec, catcodec, language compiler, etc.

@glx22
Copy link
Contributor Author

glx22 commented Nov 5, 2019

I tested something by adding a debug-files: section in manifest, used to generate the Debug Files section in
website-debug-in-manifest

Of course if no debug-files section is found, the output is like before
website-debug-not-in-manifest

@LordAro
Copy link
Member

LordAro commented Nov 5, 2019

I like it

Perhaps "Developer files" and move sources into it as well?

@TrueBrain
Copy link
Member

TrueBrain commented Nov 5, 2019

Cool :D Should the documentation also be in there? And I guess the dbg-deb files should also be there.

I personally wouldn't add the dropdown in the "developers" section, as that is just a bit silly. We use that for binaries, as it autodetects OSes and points people to the right files. No need to do that for developers :D

@glx22
Copy link
Contributor Author

glx22 commented Nov 5, 2019

Ok removed dropdown, renamed "Debug Files" to "Developer Files".
In the screenshot only pdb are present because I added them manually in _download/openttd-releases/latest.md. Presence in developer section will just depend on manifest file, files in files are shown in "download", files in dev_files are shown in "developer".

@glx22 glx22 reopened this Nov 5, 2019
@glx22 glx22 force-pushed the glx22:pdb branch from 924801b to 8c7b789 Nov 5, 2019
@glx22 glx22 changed the title Add: MSVC pdb to file description list Add: 'Developer Files' section on download pages Nov 5, 2019
_layouts/download.html Outdated Show resolved Hide resolved
@glx22
Copy link
Contributor Author

glx22 commented Nov 5, 2019

Need to add dbg.deb to _data/download-descriptions.yml but I don't know what to use as description :)

@TrueBrain
Copy link
Member

TrueBrain commented Nov 5, 2019

Now we have to agree which files to move to the Developer Files, and we need to change the manifest generation script to do the right thing there. This last part is in the OpenTTD repository itself (as @LordAro pointed out).

glx22 added a commit to glx22/OpenTTD that referenced this pull request Nov 6, 2019
glx22 added a commit to glx22/OpenTTD that referenced this pull request Nov 6, 2019
@glx22 glx22 force-pushed the glx22:pdb branch from 8c7b789 to e7ed547 Nov 6, 2019
glx22 added a commit to glx22/OpenTTD that referenced this pull request Nov 6, 2019
@glx22 glx22 force-pushed the glx22:pdb branch from e7ed547 to 4db1e7a Nov 6, 2019
glx22 added a commit to glx22/OpenTTD that referenced this pull request Nov 10, 2019
@glx22
Copy link
Contributor Author

glx22 commented Nov 23, 2019

Maybe this can go live now :)

@LordAro LordAro merged commit 618dd99 into OpenTTD:master Nov 23, 2019
1 check passed
1 check passed
website Build #20191106.2 succeeded
Details
@glx22 glx22 deleted the glx22:pdb branch Nov 24, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

4 participants
You can’t perform that action at this time.