dleidert

Add the download URL for an asset of your latest release to your Jekyll site on GitHub pages

Often there is the question to get the download URL for an asset (e.g. a setup-file) of the latest release of a project. In my case I provide an executable, which includes the version number in its name, like this:

project-X.Y.Z-setup.exe

together with the source as ZIP- and Tarball-archive. Now to get the download URLs of the assets and source archives using the GitHub API one can get and process this URL (replacing USER and PROJECT with the GitHub user account and projectname accordingly):

dleidert

{%- assign releases = site.github.releases | where: "draft", false | sort: "tag_name" | reverse -%}

## [UNRELEASED]({{ site.github.repository_url }}/tree/master/)

[compare changes to last release]({{ site.github.repository_url }}/compare/{{ releases[0].tag_name }}...master#files_bucket "Compare changes in master for upcoming release")

{% for release in releases limit:5 %}

## [{{ release.name }}]({{ release.html_url }}) {% if release.prerelease -%}(pre-release){%- endif %}

dleidert

---
layout: default
title: Debug site.github
---

```JSON
{{ site.github | neat_json }}
```

dleidert

REG ADD HKEY_LOCAL_MACHINE\SOFTWARE\Classes\SystemFileAssociations\.html\shell\edit\command /f /ve /t REG_EXPAND_SZ /d "\"^%ProgramFiles^%\Notepad++\notepad++.exe\" %1"

This will create a new key and add an Edit option to the file context menu!

dleidert

REG ADD HKEY_LOCAL_MACHINE\SOFTWARE\Classes\SystemFileAssociations\text\shell\edit\command /f /ve /t REG_EXPAND_SZ /d "\"^%ProgramFiles^%\Notepad++\notepad++.exe\" %1"

dleidert

REG ADD HKEY_LOCAL_MACHINE\SOFTWARE\Classes\SystemFileAssociations\text\shell\edit\command /f /ve /t REG_EXPAND_SZ /d "\"^%ProgramFiles^%\Notepad++\notepad++.exe\" %1"

This will overwrite the default value!

dleidert

This will prevent AppVeyor from running a job, when commits are done regarding the docs directory only. It might be useful, when the projects repository contains the GitHub pages in the master branch and changes to them are not critical to the build.

skip_commits:
  files:
    - docs/**/*

I further exclude some other files too. This is my minimal list

dleidert

I usually host a projects GitHub pages (docs/) and build service configration files (e.g. .travis.yml or .appveyor.yml) together with the projects source in the master branch. When creating a release, github creates a zip and a tar archive (the so called zipball and tarball), which can also be created these links:

https://api.github.com/repos/:user/:project/tarball
https://api.github.com/repos/:user/:project/zipball

or for a specific release:

dleidert

TRAVIS builds are triggered by every commit to the repository. When hosting github pages with the source (e.g. in the docs folder), changes to the documentation are (usually) not critical to the build itself, so they could be easily skipped. Unfortunately TRAVIS does not offer a file-/foldername-based skip instruction like e.g. AppVeyor's skip_commits field.

But there seem to be two ways of achieving (almost) the same effect. In the following examples changes to the files

.appveyor.yml
.gitattributes
.gitignore
docs/**

dleidert

Below is an example for a jekyll template to provide structed data in JSON-LD for a software application using the site.github namespace (provided by the github-metadata) plugin). Assuming there is at least one release, this snippet is a starting point. Content represented by three dots ... usually needs to be added manually to the snippet:

{%- assign release = site.github.latest_release -%}
{
  "@context": "http://schema.org/",
  "@type": "SoftwareApplication",
  "codeRepository": "{{ repository_url }}",
  "programmingLanguage": {
    "@type": "ComputerLanguage",