Skip to content

Commit

Permalink
fixed README and updated workflow to build CAEP too
Browse files Browse the repository at this point in the history
  • Loading branch information
tulshi committed Jul 13, 2023
1 parent a74e7cc commit 7488001
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 1 deletion.
9 changes: 9 additions & 0 deletions .github/workflows/build-everything.yml
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,13 @@ jobs:
run: xml2rfc openid-risc-profile-specification-1_0.xml --html -o openid-risc-profile-specification-1_0.html
- name: Render risc text
run: xml2rfc openid-risc-profile-specification-1_0.xml --text -o openid-risc-profile-specification-1_0.txt
- name: Convert caep md to xml
run: kramdown-rfc2629 openid-caep-specification-1_0.md > openid-caep-specification-1_0.xml
- name: Render HTML
- name: Render caep html
run: xml2rfc openid-caep-specification-1_0.xml --html -o openid-caep-specification-1_0.html
- name: Render caep text
run: xml2rfc openid-caep-specification-1_0.xml --text -o openid-caep-specification-1_0.txt
- name: Upload artifact
uses: actions/upload-artifact@v2
with:
Expand All @@ -43,6 +50,8 @@ jobs:
openid-sharedsignals-framework-1_0.txt
openid-risc-profile-specification-1_0.html
openid-risc-profile-specification-1_0.txt
openid-caep-specification-1_0.html
openid-caep-specification-1_0.txt
publish-to-pages:
if: github.ref == 'refs/heads/main'
needs: [build-sharedsignals]
Expand Down
13 changes: 12 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,17 @@ The goal of the [Shared Signals](http://openid.net/wg/sharedsignals/) Working Gr
* Prevent malicious actors from leveraging compromises of accounts, devices, services, endpoints, or other principals or resources to gain unauthorized access to additional systems or resources.
* Enable users, administrators, and service providers to coordinate in order to detect and respond to incidents.

## Current Development Drafts
The current drafts of the specifications under development are kept here:

| Specification | HTML | TXT |
|--------------------------|---------|--------|
| Shared Signals Framework | [HTML](https://openid.github.io/sharedsignals/openid-sharedsignals-framework-1_0.html)| [TXT](https://openid.github.io/sharedsignals/openid-sharedsignals-framework-1_0.txt)|
| CAEP | [HTML](https://openid.github.io/sharedsignals/openid-caep-specification-1_0.html)| [TXT](https://openid.github.io/sharedsignals/openid-caep-specification-1_0.txt)|
| RISC | [HTML](https://openid.github.io/sharedsignals/openid-risc-profile-specification-1_0.html)| [TXT](https://openid.github.io/sharedsignals/openid-risc-profile-specification-1_0.txt)|



## Development

To change the spec, update one of the xml files and then run `make` as follows:
Expand All @@ -16,4 +27,4 @@ Similarly, to update the text file, you would run `make foo.txt`

Pay attention to errors generating the files and warnings about the document date. You should update the date to today's date.

In order to run `make` you need to install `xml2rfc` which can be done via pip: `pip install xml2rfc`
In order to run `make` you need to install `xml2rfc` which can be done via pip: `pip install xml2rfc`

0 comments on commit 7488001

Please sign in to comment.