Skip to content

Commit 87d5ff3

Browse files
authored
fixed README and updated workflow to build CAEP too (#78)
* fixed README and updated workflow to build CAEP too * Fixed typo in script * fixed formatting issue with caep spec that was causing kramdown to fail
1 parent bb076dd commit 87d5ff3

File tree

3 files changed

+21
-1
lines changed

3 files changed

+21
-1
lines changed

.github/workflows/build-everything.yml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,12 @@ jobs:
3434
run: xml2rfc openid-risc-profile-specification-1_0.xml --html -o openid-risc-profile-specification-1_0.html
3535
- name: Render risc text
3636
run: xml2rfc openid-risc-profile-specification-1_0.xml --text -o openid-risc-profile-specification-1_0.txt
37+
- name: Convert caep md to xml
38+
run: kramdown-rfc2629 openid-caep-specification-1_0.md > openid-caep-specification-1_0.xml
39+
- name: Render caep html
40+
run: xml2rfc openid-caep-specification-1_0.xml --html -o openid-caep-specification-1_0.html
41+
- name: Render caep text
42+
run: xml2rfc openid-caep-specification-1_0.xml --text -o openid-caep-specification-1_0.txt
3743
- name: Upload artifact
3844
uses: actions/upload-artifact@v2
3945
with:
@@ -43,6 +49,8 @@ jobs:
4349
openid-sharedsignals-framework-1_0.txt
4450
openid-risc-profile-specification-1_0.html
4551
openid-risc-profile-specification-1_0.txt
52+
openid-caep-specification-1_0.html
53+
openid-caep-specification-1_0.txt
4654
publish-to-pages:
4755
if: github.ref == 'refs/heads/main'
4856
needs: [build-sharedsignals]

README.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,17 @@ The goal of the [Shared Signals](http://openid.net/wg/sharedsignals/) Working Gr
66
* 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.
77
* Enable users, administrators, and service providers to coordinate in order to detect and respond to incidents.
88

9+
## Current Development Drafts
10+
The current drafts of the specifications under development are kept here:
11+
12+
| Specification | HTML | TXT |
13+
|--------------------------|---------|--------|
14+
| 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)|
15+
| 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)|
16+
| 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)|
17+
18+
19+
920
## Development
1021

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

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

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

openid-caep-specification-1_0.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -689,6 +689,7 @@ NOTE: The event type URI is wrapped, the backslash is the continuation character
689689
{: #device-compliance-change-examples-out-of-compliance title="Example: Device No Longer Compliant - Complex Subject + optional claims"}
690690

691691
--- back
692+
692693
# Acknowledgements
693694

694695
The authors wish to thank all members of the OpenID Foundation Shared Signals

0 commit comments

Comments
 (0)