Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
70 changes: 70 additions & 0 deletions .github/workflows/publish-pages.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
name: Publish GitHub Pages

# Publishes the demo site to GitHub Pages on every push to main and on each
# published release (and on manual dispatch). The site is assembled from the
# canonical sources at build time, so nothing has to be hand-copied into
# docs/ anymore:
# - docs/index.html -> / (the demo page)
# - styles/golfTilesStyle.json -> /styles/ (pmtiles URL rewritten to the
# Pages origin: golftiles.org
# sends no CORS headers)
# - docs/samples/*.pmtiles -> /samples/ (example tilesets)
# - docs/fonts/ -> /fonts/ (self-hosted glyph ranges)
#
# Requires the repo's Pages source to be set to "GitHub Actions"
# (one-time: gh api -X PUT repos/HuggeK/golfTiles/pages -f build_type=workflow).

on:
push:
branches: [main]
release:
types: [published]
workflow_dispatch: # allow manual runs from the Actions tab

# Never cancel a deployment in progress; queue instead.
concurrency:
group: pages
cancel-in-progress: false

jobs:
publish:
runs-on: ubuntu-latest
timeout-minutes: 15
permissions:
contents: read
pages: write # required to deploy to Pages
id-token: write # required by deploy-pages for OIDC verification
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- name: Checkout
uses: actions/checkout@v4

- name: Configure Pages
id: pages
uses: actions/configure-pages@v5

- name: Assemble site
env:
BASE_URL: ${{ steps.pages.outputs.base_url }}
run: |
mkdir -p _site/styles _site/samples
cp docs/index.html _site/index.html
cp docs/samples/*.pmtiles _site/samples/
cp -r docs/fonts _site/fonts
# The canonical style points its pmtiles source at golftiles.org,
# which serves no CORS headers; the Pages copy must fetch tiles from
# its own origin. jq doubles as a JSON validity gate.
jq --arg url "pmtiles://${BASE_URL}/samples/golfTiles_se_dk_fi.pmtiles" \
'.sources.golfTiles_source.url = $url' \
styles/golfTilesStyle.json > _site/styles/golfTilesStyle.json

- name: Upload Pages artifact
uses: actions/upload-pages-artifact@v3
with:
path: _site

- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
4 changes: 3 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,6 @@
/.vscode
*:Zone.Identifier
!/docs/samples/*.pmtiles
!/tests/fixtures/*.pbf
!/tests/fixtures/*.pbf
!/docs/fonts/**/*.pbf
/_site
16 changes: 13 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,12 +102,12 @@ golfTiles/
│ └── process.lua # Process file which decides what should be included in the tiles in what layers and what vector attributes should be written to the features(Schema)
├── data/ # Folder to place your .pbf extracts to generate tiles on.
│ └── processed/ # Temporary folder used by the run_all.sh script for osmium-tool.
├── docs/ # Documentation.
├── docs/ # Documentation + sources for the GitHub Pages demo site.
│ ├── fonts/ # Self-hosted glyph .pbf ranges used by the style's glyphs property.
│ ├── samples/ # folder for samples to be downloaded by interested parties and used by the demo.
│ ├── styles/ # mirrors the styles/ folder, to be use on the github pages due to CORS
│ ├── CONTRIBUTING.md # Contributing information.
│ ├── diary.md # Some development diary documenting the early process.
│ └── index.html # The page for github pages.
│ └── index.html # The demo page for github pages.
├── openfreemap-styles/ # Git Submodule of openfreemap-styles using the OpenMapTiles schema.
├── store/ # Folder to be used as swapspace for tilemaker. TBD.
├── styles/ # Contains the maplibre GL Styles golfTilesStyle.json,
Expand All @@ -118,6 +118,16 @@ golfTiles/
└── run_all.sh # Main script to get generate .pmtiles.
```

## Publishing the demo site
The GitHub Pages demo (https://huggek.github.io/golfTiles/) is published by the
[`publish-pages.yml`](.github/workflows/publish-pages.yml) workflow, which runs on every push to
main and on every published release (or manually from the Actions tab). It assembles the site from the canonical sources — the
demo page (`docs/index.html`), the style (`styles/golfTilesStyle.json`, with its pmtiles source URL
rewritten to the Pages origin since golftiles.org serves no CORS headers), the example tilesets
(`docs/samples/`) and the self-hosted font glyphs (`docs/fonts/`) — so no copies need to be kept in
sync by hand. Longer term, golftiles.org is meant to be the bucket endpoint serving the tiles and
the style, with the GitHub Pages site acting as the demo page.

## Future technical development to solve the limitation using tileMaker
In the future one could maybe use a "dynamic" tile generator server such as:
- osm2psql
Expand Down
Binary file added docs/fonts/Open Sans Regular/0-255.pbf
Binary file not shown.
Binary file added docs/fonts/Open Sans Regular/1024-1279.pbf
Binary file not shown.
3 changes: 3 additions & 0 deletions docs/fonts/Open Sans Regular/10240-10495.pbf
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


Open Sans Regular 10240-10495
3 changes: 3 additions & 0 deletions docs/fonts/Open Sans Regular/10496-10751.pbf
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


Open Sans Regular 10496-10751
3 changes: 3 additions & 0 deletions docs/fonts/Open Sans Regular/10752-11007.pbf
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


Open Sans Regular 10752-11007
3 changes: 3 additions & 0 deletions docs/fonts/Open Sans Regular/11008-11263.pbf
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


Open Sans Regular 11008-11263
3 changes: 3 additions & 0 deletions docs/fonts/Open Sans Regular/11264-11519.pbf
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


Open Sans Regular 11264-11519
3 changes: 3 additions & 0 deletions docs/fonts/Open Sans Regular/11520-11775.pbf
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


Open Sans Regular 11520-11775
3 changes: 3 additions & 0 deletions docs/fonts/Open Sans Regular/11776-12031.pbf
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


Open Sans Regular 11776-12031
3 changes: 3 additions & 0 deletions docs/fonts/Open Sans Regular/12032-12287.pbf
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


Open Sans Regular 12032-12287
3 changes: 3 additions & 0 deletions docs/fonts/Open Sans Regular/12288-12543.pbf
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


Open Sans Regular 12288-12543
3 changes: 3 additions & 0 deletions docs/fonts/Open Sans Regular/12544-12799.pbf
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


Open Sans Regular 12544-12799
Binary file added docs/fonts/Open Sans Regular/1280-1535.pbf
Binary file not shown.
3 changes: 3 additions & 0 deletions docs/fonts/Open Sans Regular/12800-13055.pbf
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


Open Sans Regular 12800-13055
3 changes: 3 additions & 0 deletions docs/fonts/Open Sans Regular/13056-13311.pbf
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


Open Sans Regular 13056-13311
3 changes: 3 additions & 0 deletions docs/fonts/Open Sans Regular/13312-13567.pbf
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


Open Sans Regular 13312-13567
3 changes: 3 additions & 0 deletions docs/fonts/Open Sans Regular/13568-13823.pbf
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


Open Sans Regular 13568-13823
3 changes: 3 additions & 0 deletions docs/fonts/Open Sans Regular/13824-14079.pbf
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


Open Sans Regular 13824-14079
3 changes: 3 additions & 0 deletions docs/fonts/Open Sans Regular/14080-14335.pbf
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


Open Sans Regular 14080-14335
3 changes: 3 additions & 0 deletions docs/fonts/Open Sans Regular/14336-14591.pbf
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


Open Sans Regular 14336-14591
3 changes: 3 additions & 0 deletions docs/fonts/Open Sans Regular/14592-14847.pbf
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


Open Sans Regular 14592-14847
3 changes: 3 additions & 0 deletions docs/fonts/Open Sans Regular/14848-15103.pbf
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


Open Sans Regular 14848-15103
3 changes: 3 additions & 0 deletions docs/fonts/Open Sans Regular/15104-15359.pbf
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


Open Sans Regular 15104-15359
3 changes: 3 additions & 0 deletions docs/fonts/Open Sans Regular/1536-1791.pbf
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


Open Sans Regular 1536-1791
3 changes: 3 additions & 0 deletions docs/fonts/Open Sans Regular/15360-15615.pbf
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


Open Sans Regular 15360-15615
3 changes: 3 additions & 0 deletions docs/fonts/Open Sans Regular/15616-15871.pbf
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


Open Sans Regular 15616-15871
3 changes: 3 additions & 0 deletions docs/fonts/Open Sans Regular/15872-16127.pbf
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


Open Sans Regular 15872-16127
3 changes: 3 additions & 0 deletions docs/fonts/Open Sans Regular/16128-16383.pbf
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


Open Sans Regular 16128-16383
3 changes: 3 additions & 0 deletions docs/fonts/Open Sans Regular/16384-16639.pbf
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


Open Sans Regular 16384-16639
3 changes: 3 additions & 0 deletions docs/fonts/Open Sans Regular/16640-16895.pbf
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


Open Sans Regular 16640-16895
3 changes: 3 additions & 0 deletions docs/fonts/Open Sans Regular/16896-17151.pbf
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


Open Sans Regular 16896-17151
3 changes: 3 additions & 0 deletions docs/fonts/Open Sans Regular/17152-17407.pbf
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


Open Sans Regular 17152-17407
3 changes: 3 additions & 0 deletions docs/fonts/Open Sans Regular/17408-17663.pbf
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


Open Sans Regular 17408-17663
3 changes: 3 additions & 0 deletions docs/fonts/Open Sans Regular/17664-17919.pbf
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


Open Sans Regular 17664-17919
3 changes: 3 additions & 0 deletions docs/fonts/Open Sans Regular/1792-2047.pbf
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


Open Sans Regular 1792-2047
3 changes: 3 additions & 0 deletions docs/fonts/Open Sans Regular/17920-18175.pbf
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


Open Sans Regular 17920-18175
3 changes: 3 additions & 0 deletions docs/fonts/Open Sans Regular/18176-18431.pbf
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


Open Sans Regular 18176-18431
3 changes: 3 additions & 0 deletions docs/fonts/Open Sans Regular/18432-18687.pbf
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


Open Sans Regular 18432-18687
3 changes: 3 additions & 0 deletions docs/fonts/Open Sans Regular/18688-18943.pbf
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


Open Sans Regular 18688-18943
3 changes: 3 additions & 0 deletions docs/fonts/Open Sans Regular/18944-19199.pbf
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


Open Sans Regular 18944-19199
3 changes: 3 additions & 0 deletions docs/fonts/Open Sans Regular/19200-19455.pbf
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


Open Sans Regular 19200-19455
3 changes: 3 additions & 0 deletions docs/fonts/Open Sans Regular/19456-19711.pbf
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


Open Sans Regular 19456-19711
3 changes: 3 additions & 0 deletions docs/fonts/Open Sans Regular/19712-19967.pbf
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


Open Sans Regular 19712-19967
3 changes: 3 additions & 0 deletions docs/fonts/Open Sans Regular/19968-20223.pbf
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


Open Sans Regular 19968-20223
3 changes: 3 additions & 0 deletions docs/fonts/Open Sans Regular/20224-20479.pbf
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


Open Sans Regular 20224-20479
3 changes: 3 additions & 0 deletions docs/fonts/Open Sans Regular/2048-2303.pbf
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


Open Sans Regular 2048-2303
3 changes: 3 additions & 0 deletions docs/fonts/Open Sans Regular/20480-20735.pbf
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


Open Sans Regular 20480-20735
3 changes: 3 additions & 0 deletions docs/fonts/Open Sans Regular/20736-20991.pbf
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


Open Sans Regular 20736-20991
3 changes: 3 additions & 0 deletions docs/fonts/Open Sans Regular/20992-21247.pbf
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


Open Sans Regular 20992-21247
3 changes: 3 additions & 0 deletions docs/fonts/Open Sans Regular/21248-21503.pbf
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


Open Sans Regular 21248-21503
3 changes: 3 additions & 0 deletions docs/fonts/Open Sans Regular/21504-21759.pbf
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


Open Sans Regular 21504-21759
3 changes: 3 additions & 0 deletions docs/fonts/Open Sans Regular/21760-22015.pbf
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


Open Sans Regular 21760-22015
3 changes: 3 additions & 0 deletions docs/fonts/Open Sans Regular/22016-22271.pbf
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


Open Sans Regular 22016-22271
3 changes: 3 additions & 0 deletions docs/fonts/Open Sans Regular/22272-22527.pbf
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


Open Sans Regular 22272-22527
3 changes: 3 additions & 0 deletions docs/fonts/Open Sans Regular/22528-22783.pbf
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


Open Sans Regular 22528-22783
3 changes: 3 additions & 0 deletions docs/fonts/Open Sans Regular/22784-23039.pbf
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


Open Sans Regular 22784-23039
3 changes: 3 additions & 0 deletions docs/fonts/Open Sans Regular/2304-2559.pbf
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


Open Sans Regular 2304-2559
3 changes: 3 additions & 0 deletions docs/fonts/Open Sans Regular/23040-23295.pbf
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


Open Sans Regular 23040-23295
3 changes: 3 additions & 0 deletions docs/fonts/Open Sans Regular/23296-23551.pbf
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


Open Sans Regular 23296-23551
3 changes: 3 additions & 0 deletions docs/fonts/Open Sans Regular/23552-23807.pbf
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


Open Sans Regular 23552-23807
Loading
Loading