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.

Sign up for GitHub

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

Jump to bottom

Gracefully skip github info requests when the token has not been set #44

Merged
merged 1 commit into from
Sep 12, 2023
Merged

Gracefully skip github info requests when the token has not been set #44

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion layouts/_default/list.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
{{ end }}

<footer class="article-footer">
{{ partial "git-info.html" . }}
{{ partial "article-footer.html" . }}
</footer>

{{ partial "footer.html" . }}
2 changes: 1 addition & 1 deletion layouts/_default/single.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
{{ .Content }}

<footer class="article-footer">
{{ partial "git-info.html" .Page }}
{{ partial "article-footer.html" .Page }}
</footer>

{{ partial "footer.html" . }}
61 changes: 61 additions & 0 deletions layouts/partials/article-footer.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
{{ if and
(or .IsPage .IsSection)
.Site.Params.editURL
.Site.Params.versions.current
.FirstSection.Params.versionGithubPath
}}
{{- $pagePathParts := (split (replace .File.Dir "\\" "/") "/") }}
{{- $basePath := delimit (after 1 $pagePathParts) "/" }}
{{- $ghPath := printf "%s/%s" .FirstSection.Params.versionGithubpath $basePath }}
<h5 class="footerHeading">Help and support</h5>
<div class="improvedFooter">

<div class="contribute">
<h6>Help make these docs great!</h6>

<p>
The PrestaShop Developer Documentation is open source. <br>See something wrong or unclear? Submit a pull request.
</p>

<a class="github-link"
title='{{T "Improve-this-page"}}'
href="{{ .Site.Params.editURL }}{{ $ghPath }}{{ .File.LogicalName }}"
target="blank"
>
<i class="fa fa-github"></i>
<span id="top-github-link-text">
{{T "Improve-this-page"}}
</span>
</a>

<br>

<a class="how-to-improve" href="{{ .Site.Params.howToContributeURL }}">
<span>
Learn how to contribute
</span>
</a>
</div>

<div class="support">
<h6>Still need help?</h6>

<a href="https://www.prestashop-project.org/slack/">
<i class="fa fa-slack"></i> Join the PrestaShop Project’s Slack Chat
</a>
<a href="https://github.com/PrestaShop/PrestaShop/discussions">
<i class="fa fa-github"></i> Join us on Github Discussions
</a>
<a href="https://www.prestashop-project.org/support/">
<i class="fa fa-question-circle"></i> Find support on prestashop-project.org
</a>
<a href="https://build.prestashop-project.org/">
<i class="fa fa-newspaper-o"></i> Discover our developer's blog
</a>
</div>
</div>
<div class="licenceFooter">
{{ partial "git-info.html" . }}
This article is licensed under the <a rel="license" href="http://creativecommons.org/licenses/by-sa/4.0/">Creative Commons Attribution-ShareAlike 4.0 International License</a>.
</div>
{{ end }}
111 changes: 26 additions & 85 deletions layouts/partials/git-info.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,88 +1,29 @@
{{ if .GitInfo }}
<div>
Last updated on {{ .Lastmod.Format "January 2, 2006" }}
{{ with .GitInfo }}:
<a href="{{ $.Site.Params.ghCommitURL }}{{ .Hash }}">"{{ .Subject }}" ({{ .AbbreviatedHash }})</a>
{{ end }}
</div>
{{ else }}
{{ if .Site.Params.enableCustomGitInfo }}
{{ if and (or .IsPage .IsSection) .Site.Params.editURL }}
{{- $ghPath := replace .File.Dir "\\" "/" }}
{{ if and
.Site.Params.versions.current
.FirstSection.Params.versionGithubPath
}}
{{- $pagePathParts := (split (replace .File.Dir "\\" "/") "/") }}
{{- $basePath := delimit (after 1 $pagePathParts) "/" }}
{{- $ghPath = printf "%s/%s" .FirstSection.Params.versionGithubpath $basePath }}
<h5 class="footerHeading">Help and support</h5>
<div class="improvedFooter">

<div class="contribute">
<h6>Help us make these docs great!</h6>

<p>
All PrestaShop Developer Documentation are open source. See something that's wrong or unclear? Submit a pull request.
</p>

<a class="github-link"
title='{{T "Improve-this-page"}}'
href="{{ .Site.Params.editURL }}{{ $ghPath }}{{ .File.LogicalName }}"
target="blank"
>
<i class="fa fa-github"></i>
<span id="top-github-link-text">
{{T "Improve-this-page"}}
</span>
</a>

<br>

<a class="how-to-improve" href="{{ .Site.Params.howToContributeURL }}">
<span>
Learn how to contribute
</span>
</a>
</div>

<div class="support">
<h6>Still need help ?</h6>
{{ if .GitInfo }}
Last updated on {{ .Lastmod.Format "January 2, 2006" }}
{{ with .GitInfo }}:
<a href="{{ $.Site.Params.ghCommitURL }}{{ .Hash }}">"{{ .Subject }}" ({{ .AbbreviatedHash }})</a>
{{ end }}
{{ else if .Site.Params.enableCustomGitInfo }}
{{/*
Hugo does not handle git submodules properly for GitInfo.
https://github.com/gohugoio/hugo/issues/5533
As a very inefective workaround, we parse the Github API to get the last commit of the Page
*/}}
{{- $token := default "" (getenv "DEVDOCS_GITHUB_READ_TOKEN") }}
{{- if ( $token | len ) | eq 0 }}
{{- warnf "Unable to retrieve git info because the environment variable DEVDOCS_GITHUB_READ_TOKEN was not set. To disable git info, set enableCustomGitInfo to false." }}
{{- else }}
{{- $pagePathParts := (split (replace .File.Dir "\\" "/") "/") }}
{{- $basePath := delimit (after 1 $pagePathParts) "/" }}
{{- $githubApiUrl := printf
"%s?path=%s&sha=%s&page=1&per_page=1"
.Site.Params.ghApiCommitURL $basePath
.FirstSection.Params.versionGithubpath
}}
{{- $bearer := printf "BEARER %s" $token }}

<a href="https://www.prestashop-project.org/slack/">
<i class="fa fa-slack"></i> Join the PrestaShop Project’s Slack Chat
</a>
<a href="https://github.com/PrestaShop/PrestaShop/discussions">
<i class="fa fa-github"></i> Join us on Github Discussions
</a>
<a href="https://www.prestashop-project.org/support/">
<i class="fa fa-question-circle"></i> Find support on prestashop-project.org
</a>
<a href="https://build.prestashop-project.org/">
<i class="fa fa-newspaper-o"></i> Discover our developer's blog
</a>
</div>
</div>
<div class="licenceFooter">
{{/*
Hugo does not handle git submodules properly for GitInfo.
https://github.com/gohugoio/hugo/issues/5533
As a very inefective workaround, we parse the Github API to get the last commit of the Page
*/}}

{{ $githubApiUrl := printf
"%s?path=%s&sha=%s&page=1&per_page=1"
.Site.Params.ghApiCommitURL $basePath
.FirstSection.Params.versionGithubpath
}}

{{ $bearer := printf "BEARER %s" (getenv "DEVDOCS_GITHUB_READ_TOKEN") }}
{{ range getJSON $githubApiUrl (dict "Authorization" $bearer) }}
Last update on <a href="{{ .html_url }}">{{ substr .commit.author.date 0 10 }} by {{ .commit.author.name }}</a>.<br>
This article is licensed under the <a rel="license" href="http://creativecommons.org/licenses/by-sa/4.0/">Creative Commons Attribution-ShareAlike 4.0 International License</a>.
{{ end }}
</div>
{{ end }}
{{ end }}
{{ range getJSON $githubApiUrl (dict "Authorization" $bearer) }}
Last update on <a href="{{ .html_url }}">{{ substr .commit.author.date 0 10 }} by {{ .commit.author.name }}</a>.<br>
{{ end }}
{{ end }}
{{ end }}