diff --git a/.circleci/config.yml b/.circleci/config.yml new file mode 100644 index 0000000..bd1e77c --- /dev/null +++ b/.circleci/config.yml @@ -0,0 +1,101 @@ +version: 2 +jobs: + build: + docker: + - image: martinthomson/i-d-template:latest + resource_class: small + working_directory: ~/draft + + steps: + - run: + name: "Print Configuration" + command: | + xml2rfc --version + gem list -q kramdown-rfc + echo -n 'mmark '; mmark --version + + - restore_cache: + name: "Restoring cache - Git" + keys: + - v2-cache-git-{{ .Branch }}-{{ .Revision }} + - v2-cache-git-{{ .Branch }} + - v2-cache-git- + + - restore_cache: + name: "Restoring cache - References" + keys: + - v1-cache-references-{{ epoch }} + - v1-cache-references- + + # Workaround for https://discuss.circleci.com/t/22437 + - run: + name: Tag Checkout + command: | + if [ -n "$CIRCLE_TAG" ] && [ -d .git ]; then + remote=$(echo "$CIRCLE_REPOSITORY_URL" | \ + sed -e 's,/^git.github.com:,https://github.com/,') + git fetch -f "$remote" "refs/tags/$CIRCLE_TAG:refs/tags/$CIRCLE_TAG" || \ + (echo 'Removing .git cache for tag build'; rm -rf .git) + fi + + - checkout + + # Build txt and html versions of drafts + - run: + name: "Build Drafts" + command: make + + # Update editor's copy on gh-pages + - run: + name: "Update GitHub Pages" + command: | + if [ "${CIRCLE_TAG#draft-}" == "$CIRCLE_TAG" ]; then + make gh-pages + fi + + # For tagged builds, upload to the datatracker. + - deploy: + name: "Upload to Datatracker" + command: | + if [ "${CIRCLE_TAG#draft-}" != "$CIRCLE_TAG" ]; then + make upload + fi + + # Archive GitHub Issues + - run: + name: "Archive GitHub Issues" + command: "make archive || make archive DISABLE_ARCHIVE_FETCH=true && make gh-archive" + + # Create and store artifacts + - run: + name: "Create Artifacts" + command: "make artifacts CI_ARTIFACTS=/tmp/artifacts" + + - store_artifacts: + path: /tmp/artifacts + + - run: + name: "Prepare for Caching" + command: "git reflog expire --expire=now --all && git gc --prune=now" + + - save_cache: + name: "Saving Cache - Git" + key: v2-cache-git-{{ .Branch }}-{{ .Revision }} + paths: + - ~/draft/.git + + - save_cache: + name: "Saving Cache - Drafts" + key: v1-cache-references-{{ epoch }} + paths: + - ~/.cache/xml2rfc + + +workflows: + version: 2 + build: + jobs: + - build: + filters: + tags: + only: /.*?/ 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/.gitignore b/.gitignore new file mode 100644 index 0000000..27843be --- /dev/null +++ b/.gitignore @@ -0,0 +1,23 @@ +*.html +*.pdf +*.redxml +*.swp +*.txt +*.upload +*~ +.tags +/*-[0-9][0-9].xml +/.gems/ +/.refcache +/.targets.mk +/.venv/ +/.vscode/ +/lib +/node_modules/ +/versioned/ +Gemfile.lock +archive.json +draft-richer-wimse-token-container.xml +package-lock.json +report.xml +!requirements.txt diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..27361af --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,31 @@ +# Contributing + +This repository relates to activities in the Internet Engineering Task Force +([IETF](https://www.ietf.org/)). All material in this repository is considered +Contributions to the IETF Standards Process, as defined in the intellectual +property policies of IETF currently designated as +[BCP 78](https://www.rfc-editor.org/info/bcp78), +[BCP 79](https://www.rfc-editor.org/info/bcp79) and the +[IETF Trust Legal Provisions (TLP) Relating to IETF Documents](http://trustee.ietf.org/trust-legal-provisions.html). + +Any edit, commit, pull request, issue, comment or other change made to this +repository constitutes Contributions to the IETF Standards Process +(https://www.ietf.org/). + +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 + +Discussion of this work occurs on the [Workload Identity in Multi System Environments +Working Group mailing list](mailto:wimse@ietf.org) +([archive](https://mailarchive.ietf.org/arch/browse/wimse/), +[subscribe](https://www.ietf.org/mailman/listinfo/wimse)). +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/wimse/documents/). diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..696b752 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,4 @@ +# License + +See the +[guidelines for contributions](https://github.com/dhs-aws/wimse-token-exch-design-team/blob/main/CONTRIBUTING.md). diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..de46d56 --- /dev/null +++ b/Makefile @@ -0,0 +1,11 @@ +LIBDIR := lib +include $(LIBDIR)/main.mk + +$(LIBDIR)/main.mk: +ifneq (,$(shell grep "path *= *$(LIBDIR)" .gitmodules 2>/dev/null)) + git submodule sync + git submodule update $(CLONE_ARGS) --init +else + git clone -q --depth 10 $(CLONE_ARGS) \ + -b main https://github.com/martinthomson/i-d-template $(LIBDIR) +endif diff --git a/README.md b/README.md index f699359..255297d 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,31 @@ -# Internet-Draft Template Repository +# WIMSE Token Exchange and Translation Protocol -Use this repository as a template if you want to start working on -[IETF](https://www.ietf.org/) documents. +This is the working area for the individual Internet-Draft, "WIMSE Token Exchange and Translation Protocol". -[Read the -instructions](https://github.com/martinthomson/i-d-template/blob/main/doc/TEMPLATE.md) -for more information. +* [Editor's Copy](https://dhs-aws.github.io/wimse-token-exch-design-team/#go.draft-saxe-wimse-token-exchange-and-translation-protocol.html) +* [Datatracker Page](https://datatracker.ietf.org/doc/draft-saxe-wimse-token-exchange-and-translation-protocol) +* [Individual Draft](https://datatracker.ietf.org/doc/html/draft-saxe-wimse-token-exchange-and-translation-protocol) +* [Compare Editor's Copy to Individual Draft](https://dhs-aws.github.io/wimse-token-exch-design-team/#go.draft-saxe-wimse-token-exchange-and-translation-protocol.diff) -Once you have created your own repository, start work by: -1. Set "Workflow permissions" to "Read and write permissions" - [in the repository settings](../../settings/actions#actions_default_workflow_permissions_write). +## Contributing + +See the +[guidelines for contributions](https://github.com/dhs-aws/wimse-token-exch-design-team/blob/main/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 +``` + +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). + -2. Rename the `draft-todo-yourname-protocol.md` file - [here](../../edit/main/draft-todo-yourname-protocol.md). diff --git a/draft-saxe-wimse-token-exchange-and-translation-protocol.md b/draft-saxe-wimse-token-exchange-and-translation-protocol.md index 3e94b9c..9433538 100644 --- a/draft-saxe-wimse-token-exchange-and-translation-protocol.md +++ b/draft-saxe-wimse-token-exchange-and-translation-protocol.md @@ -23,25 +23,25 @@ title: WIMSE Token Exchange and Translation Protocol abbrev: WIMSE Token Exchange & Translation category: info -docname: draft-saxe-wimse-token-exchange-and-translation-protocol +docname: draft-saxe-wimse-token-exchange-and-translation-protocol-latest submissiontype: IETF # also: "independent", "editorial", "IAB", or "IRTF" number: 1 -date: +date: consensus: true v: 3 -area: AREA -workgroup: WIMSE +area: "Applications and Real-Time" +workgroup: "Workload Identity in Multi System Environments" keyword: - workload identity - token exchange - token translation venue: - group: WIMSE - type: Working Group - mail: WG@example.com - arch: https://example.com/WG - github: dhs-aws/wimse-token-exch-design-team - latest: https://example.com/LATEST + group: "Workload Identity in Multi System Environments" + type: "Working Group" + mail: "wimse@ietf.org" + arch: "https://mailarchive.ietf.org/arch/browse/wimse/" + github: "dhs-aws/wimse-token-exch-design-team" + latest: "https://dhs-aws.github.io/wimse-token-exch-design-team/draft-saxe-wimse-token-exchange-and-translation-protocol.html" author: - fullname: Dean H. Saxe @@ -51,7 +51,7 @@ author: - fullname: George Fletcher organization: Capital One email: george.fletcher@capitalone.com - + normative: informative: