Skip to content

Commit

Permalink
updated readme, updated build removing non working pages activation step
Browse files Browse the repository at this point in the history
  • Loading branch information
santilland committed Mar 7, 2024
1 parent e9ac83a commit 7c73d16
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 10 deletions.
10 changes: 0 additions & 10 deletions .github/workflows/build_main.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -40,15 +40,5 @@ jobs:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./build
force_orphan: true
# Make sure github pages is enabled and set to gh-pages branch
- name: Update GitHub Pages source
run: |
curl -L \
-X POST \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer ${{ secrets.GITHUB_TOKEN }}" \
-H "X-GitHub-Api-Version: 2022-11-28" \
"https://api.github.com/repos/${{ github.repository }}/pages" \
-d '{"source":{"branch":"main","path":"/"}}'


16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,18 @@
# catalog-template
Template for creating eodash catalog repository

## How-to
You can create a new repository using the "use this template" button.
This will set-up a catalog repository for you with example configuration files as well as a github workflow that will automatically build and deploy the STAC catalog to the gh-page branch.
For every commit you push to the main branch the catalog will be regenerated and deployed there.

To make the build catalog available through github pages, please go to:
* repository settings
- Pages (left side panel)
- Source: "Deploy from branch" (should be selected)
- Branch: Select "gh-pages" from dropdown
- (leave root selected)
- Click on save

Once enabled you can navigate to the catalog using:
https://<organization>.github.io/<repository>/<catalog_name>/catalog.json

0 comments on commit 7c73d16

Please sign in to comment.