diff --git a/.github/workflows/gh-pages.yml b/.github/workflows/gh-pages.yml new file mode 100644 index 0000000..dff4e92 --- /dev/null +++ b/.github/workflows/gh-pages.yml @@ -0,0 +1,71 @@ +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@v2 + + - name: install xml2rfc + run: | + pip install --upgrade pip + pip install xml2rfc + + - 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: build openid federation specs + run: xml2rfc --html rp-metadata-choices-1_0.xml --out html/$BRANCH_NAME.html + + - name: Deploy to GitHub Pages + if: success() + uses: crazy-max/ghaction-github-pages@v2 + with: + target_branch: gh-pages + build_dir: html + keep_history: true + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..c8b5ef4 --- /dev/null +++ b/.gitignore @@ -0,0 +1,3 @@ +env +openid-federation-1_0.html + diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..f44026c --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,19 @@ +# How to Contribute + +The OpenID Connect working group page is https://openid.net/wg/connect/. It describes how to participate in the working group, including OpenID Federation. + +You can send feedback on the specification in a way that enables the working group to act upon it by +1. signing the contribution agreement at https://openid.net/intellectual-property/ to join the working group (please specify that you are joining the “AB/Connect” working group on your contribution agreement), +2. joining the working group mailing list at https://lists.openid.net/mailman/listinfo/openid-specs-ab, and +3. sending your feedback to the list. + +Working group members can also contribute via GitHub. + +When contributing, 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 that were approved during a Working Group call. +- **Commit Messages**: Use clear and descriptive commit messages. + +Thanks,
+OpenID Connect Working Group diff --git a/README.md b/README.md new file mode 100644 index 0000000..378bc07 --- /dev/null +++ b/README.md @@ -0,0 +1,38 @@ +# OpenID Federation 1.0 + +This repository contains the OpenID Federation specification, which has been migrated from [Bitbucket](https://bitbucket.org/openid/connect/src/master/) to the OpenID Foundation's GitHub. +The OpenID Federation specification defines protocols and guidelines for implementing federated infrastructures among different domains and services. + +## Overview + +OpenID Federation 1.0 is: + +- a technical specification that shows us how to evaluate the Trust from a technical perspective, +- a technology that defines how to build trust infrastructures, +- a system for securely establishing the interoperability of participants. + +## Status + +News about OpenID Federation is available at the OpenID Foundation website [here](https://openid.net/tag/federation/). + +The latest released draft of the specification is available at [https://openid.net/specs/openid-federation-1_0.html](https://openid.net/specs/openid-federation-1_0.html). +The most recent Implementer's Draft is available at [https://openid.net/specs/openid-federation-1_0-ID4.html](https://openid.net/specs/openid-federation-1_0-ID4.html). + +## Builds + +You can view the latest editors' draft at [https://openid.github.io/federation/main.html](https://openid.github.io/federation/main.html). + +Previews for each branch of this project are automatically built and published at the URL https://openid.github.io/federation/$branchname.html. +Previews for branches associated with pending Pull Requests are accessible using this pattern. + +## Getting Started +To get started working on the OpenID Federation specification, clone this repository and review the documentation provided in the root directory. + +````bash +git clone https://github.com/openid/federation.git +cd federation +```` +Please read the [CONTRIBUTING.md](CONTRIBUTING.md) to learn how to contribute to this project. + +## Contact +For further information and to get involved, please visit the [OpenID Connect Working Group website](https://openid.net/wg/connect/). diff --git a/rp-metadata-choices-1_0.xml b/rp-metadata-choices-1_0.xml new file mode 100644 index 0000000..e69de29