Skip to content

Commit

Permalink
Setup repository for draft-selander-ace-ake-authz using https://githu…
Browse files Browse the repository at this point in the history
  • Loading branch information
malishav committed Oct 20, 2021
1 parent 3242b52 commit b951a29
Show file tree
Hide file tree
Showing 12 changed files with 229 additions and 29 deletions.
12 changes: 6 additions & 6 deletions .circleci/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ jobs:
build:
docker:
- image: martinthomson/i-d-template:latest
resource_class: small
working_directory: ~/draft

steps:
Expand All @@ -18,7 +19,6 @@ jobs:
keys:
- v2-cache-git-{{ .Branch }}-{{ .Revision }}
- v2-cache-git-{{ .Branch }}
- v2-cache-git-master
- v2-cache-git-

- restore_cache:
Expand All @@ -43,7 +43,7 @@ jobs:
# Build txt and html versions of drafts
- run:
name: "Build Drafts"
command: "make 'CLONE_ARGS=--reference ~/git-reference'"
command: make

# Update editor's copy on gh-pages
- run:
Expand All @@ -61,10 +61,10 @@ jobs:
make upload
fi
# Save GitHub issues
# Archive GitHub Issues
- run:
name: "Save GitHub Issues"
command: "make issues || make issues DISABLE_ISSUE_FETCH=true && make gh-issues"
name: "Archive GitHub Issues"
command: "make archive || make archive DISABLE_ARCHIVE_FETCH=true && make gh-archive"

# Create and store artifacts
- run:
Expand All @@ -76,7 +76,7 @@ jobs:

- run:
name: "Prepare for Caching"
command: "git gc --auto"
command: "git reflog expire --expire=now --all && git gc --prune=now"

- save_cache:
name: "Saving Cache - Git"
Expand Down
8 changes: 8 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# See http://editorconfig.org

root = true

[*.{md,xml,org}]
charset = utf-8
insert_final_newline = true
trim_trailing_whitespace = true
3 changes: 3 additions & 0 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Automatically generated CODEOWNERS
# Regenerate with `make update-codeowners`
draft-selander-ace-ake-authz.md [email protected] [email protected] [email protected] [email protected] [email protected]
33 changes: 33 additions & 0 deletions .github/workflows/archive.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
name: "Archive Issues and Pull Requests"

on:
schedule:
- cron: '0 0 * * 0,2,4'
repository_dispatch:
types: [archive]
workflow_dispatch:

jobs:
build:
name: "Archive Issues and Pull Requests"
runs-on: ubuntu-latest
steps:
- name: "Checkout"
uses: actions/checkout@v2

- name: "Update Archive"
uses: martinthomson/i-d-template@v1
with:
make: archive
token: ${{ github.token }}

- name: "Update GitHub Pages"
uses: martinthomson/i-d-template@v1
with:
make: gh-archive
token: ${{ github.token }}

- name: "Save Archive"
uses: actions/upload-artifact@v2
with:
path: archive.json
60 changes: 60 additions & 0 deletions .github/workflows/ghpages.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
name: "Update Editor's Copy"

on:
push:
paths-ignore:
- README.md
- CONTRIBUTING.md
- LICENSE.md
- .gitignore
pull_request:
paths-ignore:
- README.md
- CONTRIBUTING.md
- LICENSE.md
- .gitignore

jobs:
build:
name: "Update Editor's Copy"
runs-on: ubuntu-latest
steps:
- name: "Checkout"
uses: actions/checkout@v2

- name: "Cache Setup"
id: cache-setup
run: |
mkdir -p "$HOME"/.cache/xml2rfc
echo "::set-output name=path::$HOME/.cache/xml2rfc"
date -u "+::set-output name=date::%FT%T"
- name: "Cache References"
uses: actions/cache@v2
with:
path: |
${{ steps.cache-setup.outputs.path }}
.targets.mk
key: refcache-${{ steps.cache-setup.outputs.date }}
restore-keys: |
refcache-${{ steps.cache-setup.outputs.date }}
refcache-
- name: "Build Drafts"
uses: martinthomson/i-d-template@v1
with:
token: ${{ github.token }}

- name: "Update GitHub Pages"
uses: martinthomson/i-d-template@v1
if: ${{ github.event_name == 'push' }}
with:
make: gh-pages
token: ${{ github.token }}

- name: "Archive Built Drafts"
uses: actions/upload-artifact@v2
with:
path: |
draft-*.html
draft-*.txt
51 changes: 51 additions & 0 deletions .github/workflows/publish.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
name: "Publish New Draft Version"

on:
push:
tags:
- "draft-*"

jobs:
build:
name: "Publish New Draft Version"
runs-on: ubuntu-latest
steps:
- name: "Checkout"
uses: actions/checkout@v2

# See https://github.com/actions/checkout/issues/290
- name: "Get Tag Annotations"
run: git fetch -f origin ${{ github.ref }}:${{ github.ref }}

- name: "Cache Setup"
id: cache-setup
run: |
mkdir -p "$HOME"/.cache/xml2rfc
echo "::set-output name=path::$HOME/.cache/xml2rfc"
date -u "+::set-output name=date::%FT%T"
- name: "Cache References"
uses: actions/cache@v2
with:
path: |
${{ steps.cache-setup.outputs.path }}
.targets.mk
key: refcache-${{ steps.date.outputs.date }}
restore-keys: |
refcache-${{ steps.date.outputs.date }}
refcache-
- name: "Build Drafts"
uses: martinthomson/i-d-template@v1
with:
token: ${{ github.token }}

- name: "Upload to Datatracker"
uses: martinthomson/i-d-template@v1
with:
make: upload

- name: "Archive Submitted Drafts"
uses: actions/upload-artifact@v2
with:
path: "draft-*-[0-9][0-9].xml"
36 changes: 36 additions & 0 deletions .github/workflows/update.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
name: "Update generated files"
# This rule is not run automatically.
# It can be run manually to update all of the files that are part
# of the template, specifically:
# - README.md
# - CONTRIBUTING.md
# - .note.xml
# - .github/CODEOWNERS
# - Makefile
#
#
# This might be useful if you have:
# - added, removed, or renamed drafts (including after adoption)
# - added, removed, or changed draft editors
# - changed the title of drafts
#
# Note that this removes any customizations you have made to
# the affected files.
on: workflow_dispatch

jobs:
build:
name: "Update files"
runs-on: ubuntu-latest
steps:
- name: "Checkout"
uses: actions/checkout@v2

- name: "Update generated files"
uses: martinthomson/i-d-template@v1
with:
make: update-files
token: ${{ github.token }}

- name: "Push Update"
run: git push
7 changes: 3 additions & 4 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,8 @@
.tags
.targets.mk
/*-[0-9][0-9].xml
issues.json
pulls.json
archive.json
draft-selander-ace-ake-authz.xml
lib
report.xml
venv/
lib
draft-selander-ace-ake-authz.xml
7 changes: 5 additions & 2 deletions .note.xml
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
<note title="Note to Readers">
<note title="Discussion Venues" removeInRFC="true">
<t>Discussion of this document takes place on the
Authentication and Authorization for Constrained Environments Working Group mailing list ([email protected]),
which is archived at <eref target="https://mailarchive.ietf.org/arch/browse/ace/"/>.</t>
<t>Source for this draft and an issue tracker can be found at
<eref target="https://github.com/EricssonResearch/ace-ake-authz">https://github.com/EricssonResearch/ace-ake-authz</eref>.</t>
<eref target="https://github.com/EricssonResearch/ace-ake-authz"/>.</t>
</note>
15 changes: 8 additions & 7 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,16 +16,17 @@ You agree to comply with all applicable IETF policies and procedures, including,
BCP 78, 79, the TLP, and the TLP rules regarding code components (e.g. being
subject to a Simplified BSD License) in Contributions.

## Working Group Information

## Other Resources

Discussion of this work occurs on the
[ace working group mailing list](https://mailarchive.ietf.org/arch/browse/ace/)
([subscribe](https://www.ietf.org/mailman/listinfo/ace)). In addition to
contributions in GitHub, you are encouraged to participate in discussions there.
Discussion of this work occurs on the [Authentication and Authorization for Constrained Environments
Working Group mailing list](mailto:[email protected])
([archive](https://mailarchive.ietf.org/arch/browse/ace/),
[subscribe](https://www.ietf.org/mailman/listinfo/ace)).
In addition to contributions in GitHub, you are encouraged to participate in
discussions there.

**Note**: Some working groups adopt a policy whereby substantive discussion of
technical issues needs to occur on the mailing list.

You might also like to familiarize yourself with other
[working group documents](https://datatracker.ietf.org/wg/ace/documents/).
[Working Group documents](https://datatracker.ietf.org/wg/ace/documents/).
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,5 @@ ifneq (,$(shell grep "path *= *$(LIBDIR)" .gitmodules 2>/dev/null))
git submodule update $(CLONE_ARGS) --init
else
git clone -q --depth 10 $(CLONE_ARGS) \
-b master https://github.com/martinthomson/i-d-template $(LIBDIR)
-b main https://github.com/martinthomson/i-d-template $(LIBDIR)
endif
24 changes: 15 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,22 +3,28 @@
This is the working area for the individual Internet-Draft, "Lightweight Authorization for Authenticated Key Exchange.".

* [Editor's Copy](https://EricssonResearch.github.io/ace-ake-authz/#go.draft-selander-ace-ake-authz.html)
* [Individual Draft](https://tools.ietf.org/html/draft-selander-ace-ake-authz)
* [Datatracker Page](https://datatracker.ietf.org/doc/draft-selander-ace-ake-authz)
* [Individual Draft](https://datatracker.ietf.org/doc/html/draft-selander-ace-ake-authz)
* [Compare Editor's Copy to Individual Draft](https://EricssonResearch.github.io/ace-ake-authz/#go.draft-selander-ace-ake-authz.diff)

## Building the Draft

## Contributing

See the
[guidelines for contributions](https://github.com/EricssonResearch/ace-ake-authz/blob/master/CONTRIBUTING.md).

Contributions can be made by creating pull requests.
The GitHub interface supports creating pull requests using the Edit (✏) button.


## Command Line Usage

Formatted text and HTML versions of the draft can be built using `make`.

```sh
$ make
```

This requires that you have the necessary software installed. See
[the instructions](https://github.com/martinthomson/i-d-template/blob/master/doc/SETUP.md).


## Contributing
Command line usage requires that you have the necessary software installed. See
[the instructions](https://github.com/martinthomson/i-d-template/blob/main/doc/SETUP.md).

See the
[guidelines for contributions](https://github.com/EricssonResearch/ace-ake-authz/blob/master/CONTRIBUTING.md).

0 comments on commit b951a29

Please sign in to comment.