Skip to content

Commit

Permalink
added initial specification (#1)
Browse files Browse the repository at this point in the history
* added iniitial specification
  • Loading branch information
MichaelFraser1999 authored Aug 2, 2024
1 parent 1186be8 commit d719e97
Show file tree
Hide file tree
Showing 5 changed files with 456 additions and 2 deletions.
70 changes: 70 additions & 0 deletions .github/workflows/build-federation-extended-listing.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
name: gh-pages

on:
# Runs on pushes targeting the default branch
push:
paths-ignore:
- README.md
- CONTRIBUTING.md
- LICENSE.md
- .gitignore
branches: ["*"]
release:
types:
- created
- edited

# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: write
pages: write
id-token: write

# Allow one concurrent deployment
concurrency:
group: "pages"
cancel-in-progress: true

jobs:
build-and-deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
env:
BRANCH_NAME: ${{ github.head_ref || github.ref_name }}
steps:
# Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
- uses: actions/checkout@v4

- name: Show env
run: echo "$GITHUB_CONTEXT"

- name: Create html folder
run: mkdir html

- name: Show folders
run: ls -al

- name: Show branch name
run: echo "$BRANCH_NAME"

- name: Run the build process with Docker
run: |
docker run -v `pwd`:/data danielfett/markdown2rfc openid-federation-extended-listing-1_0.md
- name: rename
run: |
mv ./openid-federation-extended-listing*.html ./html/$BRANCH_NAME.html
- name: Deploy to GitHub Pages
if: success()
uses: crazy-max/ghaction-github-pages@v4
with:
target_branch: gh-pages
build_dir: html
keep_history: true
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
.idea
.DS_Store
*.html
*.xml
7 changes: 7 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# How to Contribute

When contributing via GitHub, please adhere to the following guidelines:

- **Issues**: Use the issue tracker to report problems or suggest enhancements.
- **Pull Requests**: Submit pull requests linked to Issues.
- **Commit Messages**: Use clear and descriptive commit messages.
15 changes: 13 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,13 @@
# federation-extended-listing
OpenID Federation Subordinate Listings Specification
# OpenID Federation Extended Subordinate Listing 1.0

This repository contains the specification for OpenID Federation Extended Subordinate Listing.
This specification acts as an extension to OpenID Federation 1.0 and proposes an alternative listing endpoint enabling consumers to retrieve segmented pages of data as well as bulk retrieving information.


## Build the HTML ##

```docker run -v `pwd`:/data danielfett/markdown2rfc openid-federation-wallet-1_0.md```

## Contact

For further information and to get involved, please contact the authors.
Loading

0 comments on commit d719e97

Please sign in to comment.