From b951a29346f5adbb88e461de65ea44a9db148cb9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mali=C5=A1a=20Vu=C4=8Dini=C4=87?= Date: Wed, 20 Oct 2021 09:42:51 +0200 Subject: [PATCH] Setup repository for draft-selander-ace-ake-authz using https://github.com/martinthomson/i-d-template --- .circleci/config.yml | 12 +++---- .editorconfig | 8 +++++ .github/CODEOWNERS | 3 ++ .github/workflows/archive.yml | 33 +++++++++++++++++++ .github/workflows/ghpages.yml | 60 +++++++++++++++++++++++++++++++++++ .github/workflows/publish.yml | 51 +++++++++++++++++++++++++++++ .github/workflows/update.yml | 36 +++++++++++++++++++++ .gitignore | 7 ++-- .note.xml | 7 ++-- CONTRIBUTING.md | 15 +++++---- Makefile | 2 +- README.md | 24 ++++++++------ 12 files changed, 229 insertions(+), 29 deletions(-) create mode 100644 .editorconfig create mode 100644 .github/CODEOWNERS create mode 100644 .github/workflows/archive.yml create mode 100644 .github/workflows/ghpages.yml create mode 100644 .github/workflows/publish.yml create mode 100644 .github/workflows/update.yml diff --git a/.circleci/config.yml b/.circleci/config.yml index 8783f33..f164ef4 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -3,6 +3,7 @@ jobs: build: docker: - image: martinthomson/i-d-template:latest + resource_class: small working_directory: ~/draft steps: @@ -18,7 +19,6 @@ jobs: keys: - v2-cache-git-{{ .Branch }}-{{ .Revision }} - v2-cache-git-{{ .Branch }} - - v2-cache-git-master - v2-cache-git- - restore_cache: @@ -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: @@ -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: @@ -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" diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..8682023 --- /dev/null +++ b/.editorconfig @@ -0,0 +1,8 @@ +# See http://editorconfig.org + +root = true + +[*.{md,xml,org}] +charset = utf-8 +insert_final_newline = true +trim_trailing_whitespace = true diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS new file mode 100644 index 0000000..6ac3371 --- /dev/null +++ b/.github/CODEOWNERS @@ -0,0 +1,3 @@ +# Automatically generated CODEOWNERS +# Regenerate with `make update-codeowners` +draft-selander-ace-ake-authz.md goran.selander@ericsson.com john.mattsson@ericsson.com malisa.vucinic@inria.fr mcr+ietf@sandelman.ca aureliorubendario.schellenbaum@zhaw.ch diff --git a/.github/workflows/archive.yml b/.github/workflows/archive.yml new file mode 100644 index 0000000..bfad094 --- /dev/null +++ b/.github/workflows/archive.yml @@ -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 diff --git a/.github/workflows/ghpages.yml b/.github/workflows/ghpages.yml new file mode 100644 index 0000000..118cb52 --- /dev/null +++ b/.github/workflows/ghpages.yml @@ -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 diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml new file mode 100644 index 0000000..dd94df9 --- /dev/null +++ b/.github/workflows/publish.yml @@ -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" diff --git a/.github/workflows/update.yml b/.github/workflows/update.yml new file mode 100644 index 0000000..79a3ca5 --- /dev/null +++ b/.github/workflows/update.yml @@ -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 diff --git a/.gitignore b/.gitignore index a5dfb7f..bc32773 100644 --- a/.gitignore +++ b/.gitignore @@ -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 diff --git a/.note.xml b/.note.xml index 0b9f046..6d2da2e 100644 --- a/.note.xml +++ b/.note.xml @@ -1,4 +1,7 @@ - + +Discussion of this document takes place on the + Authentication and Authorization for Constrained Environments Working Group mailing list (ace@ietf.org), + which is archived at . Source for this draft and an issue tracker can be found at - https://github.com/EricssonResearch/ace-ake-authz. + . diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1fc4afd..c10fdc7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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:ace@ietf.org) +([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/). diff --git a/Makefile b/Makefile index 1a21518..de46d56 100644 --- a/Makefile +++ b/Makefile @@ -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 diff --git a/README.md b/README.md index ebfa546..8d7974b 100644 --- a/README.md +++ b/README.md @@ -3,10 +3,21 @@ 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`. @@ -14,11 +25,6 @@ Formatted text and HTML versions of the draft can be built using `make`. $ 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).