Site url not being set properly

[AgrawalAmey]

Checks

• I have searched the docs, existing issues, and existing discussions for answers first.

Link to your website repo

NA

Version of Lab Website Template you are using

NA

Description

Currently, the sitemap generated with this template doesn't get parsed correctly by google. jekyll-sitemap requires "url" attribute to be set in _config.yml. I suppose we should update the instructions to capture that.

[vincerubinetti]

The site url is (supposed to be) set automatically right before the site is built each time on github actions:
https://github.com/greenelab/lab-website-template/blob/main/.github/workflows/build-site.yaml#L45

However I forgot that echo prints newlines literally. Here is a hot fix that you can apply, or you can wait for v1.2.1 to be ready.

6aa88ee

Also, please next time do not open an issue without including your repo and version. To debug this issue I had to look through your repos to try to find the one you're seeing the problem in and dig through the workflow runs. This isn't sustainable for me.

[AgrawalAmey]

Hi Vincent, Thanks a lot for building this awesome template! I had fixed the problem by manually adding url to the config file, and thus skipped the site details, sorry for the inconvenience. I just wanted to bring attention to this issue. Thanks! Sincerely, Amey

…

On Fri, Mar 22, 2024, 10:49 PM Vincent Rubinetti ***@***.***> wrote: The site url is (supposed to be) set automatically right before the site is built each time on github actions: https://github.com/greenelab/lab-website-template/blob/main/.github/workflows/build-site.yaml#L45 However I forgot that echo prints newlines literally. Here is a hot fix that you can apply, or you can wait for v1.2.1 to be ready. 6aa88ee <6aa88ee> Also, please next time do not open an issue without including your repo and version. To debug this issue I had to look through your repos to try to find the one you're seeing the problem in and dig through the workflow runs. This isn't sustainable for me. — Reply to this email directly, view it on GitHub <#246 (comment)> or unsubscribe <https://github.com/notifications/unsubscribe-auth/ADUFR2IXZR2CCDLW4HROQETYZTUVNBFKMF2HI4TJMJ2XIZLTSOBKK5TBNR2WLJDUOJ2WLJDOMFWWLO3UNBZGKYLEL5YGC4TUNFRWS4DBNZ2F6YLDORUXM2LUPGBKK5TBNR2WLJDUOJ2WLJDOMFWWLLTXMF2GG2C7MFRXI2LWNF2HTAVFOZQWY5LFUVUXG43VMWSG4YLNMWVXI2DSMVQWIX3UPFYGLLDTOVRGUZLDORPXI6LQMWWES43TOVSUG33NNVSW45FGORXXA2LDOOJIFJDUPFYGLKTSMVYG643JORXXE6NFOZQWY5LFVEZDSNRWHAYDSMZYQKSHI6LQMWSWS43TOVS2K5TBNR2WLKRSGIYDGNJXG4YDCN5HORZGSZ3HMVZKMY3SMVQXIZI> . You are receiving this email because you authored the thread. Triage notifications on the go with GitHub Mobile for iOS <https://apps.apple.com/app/apple-store/id1477376905?ct=notification-email&mt=8&pt=524675> or Android <https://play.google.com/store/apps/details?id=com.github.android&referrer=utm_campaign%3Dnotification-email%26utm_medium%3Demail%26utm_source%3Dgithub> .

[p-ang]

To add to this, the jekyll-sitemap plugin needs a url: property set on the _config.yaml file to create valid sitemap.xml and robots.txt files. Without it, the files generated might not have a fully qualified URL and, therefore, will not be syntactically valid.

I suggest adding a manual setting there instead of relying on github actions!

[vincerubinetti]

The entire template is based around github actions automating as much of the process as possible for users. That would not be in line with the way the rest of the template is designed. The docs also do not mention manually setting a "baseurl" because it was a consistent source of confusion for users, so the template does it automatically for them.

The only way the user would need to manually set the url in the config file is if they were building their site locally (or via some other process) and deploying it manually, which is completely outside the scope of the docs.