Skip to content

Commit

Permalink
Setup repository for draft-irtf-cfrg-cryptography-specification using h…
Browse files Browse the repository at this point in the history
  • Loading branch information
ID Bot committed Jul 10, 2023
1 parent ca37574 commit 30eda9b
Show file tree
Hide file tree
Showing 7 changed files with 127 additions and 9 deletions.
101 changes: 101 additions & 0 deletions .circleci/config.yml
Original file line number Diff line number Diff line change
@@ -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: /.*?/
2 changes: 1 addition & 1 deletion .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Automatically generated CODEOWNERS
# Regenerate with `make update-codeowners`
draft-sullivan-cryptography-specification.md [email protected] [email protected]
draft-irtf-cfrg-cryptography-specification.md [email protected] [email protected]
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
/versioned/
Gemfile.lock
archive.json
draft-sullivan-cryptography-specification.xml
draft-irtf-cfrg-cryptography-specification.xml
package-lock.json
report.xml
!requirements.txt
5 changes: 4 additions & 1 deletion .note.xml
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
<note title="Discussion Venues" removeInRFC="true">
<t>Discussion of this document takes place on the
Crypto Forum Research Group mailing list ([email protected]),
which is archived at <eref target="https://mailarchive.ietf.org/arch/search/?email_list=cfrg"/>.</t>
<t>Source for this draft and an issue tracker can be found at
<eref target="https://github.com/grittygrease/draft-sullivan-cryptography-specification"/>.</t>
<eref target="https://github.com/cfrg/draft-irtf-cfrg-cryptography-specification"/>.</t>
</note>
14 changes: 14 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,17 @@ repository constitutes Contributions to the IETF Standards Process
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 [Crypto Forum
Research Group mailing list](mailto:[email protected])
([archive](https://mailarchive.ietf.org/arch/search/?email_list=cfrg),
[subscribe](http://irtf.org/mailman/listinfo/cfrg)).
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
[Research Group documents](https://datatracker.ietf.org/rg/cfrg/documents/).
2 changes: 1 addition & 1 deletion LICENSE.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# License

See the
[guidelines for contributions](https://github.com/grittygrease/draft-sullivan-cryptography-specification/blob/main/CONTRIBUTING.md).
[guidelines for contributions](https://github.com/cfrg/draft-irtf-cfrg-cryptography-specification/blob/main/CONTRIBUTING.md).
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,16 @@

This is the working area for the individual Internet-Draft, "Guidelines for Writing Cryptography Specifications".

* [Editor's Copy](https://grittygrease.github.io/draft-sullivan-cryptography-specification/#go.draft-sullivan-cryptography-specification.html)
* [Datatracker Page](https://datatracker.ietf.org/doc/draft-sullivan-cryptography-specification)
* [Individual Draft](https://datatracker.ietf.org/doc/html/draft-sullivan-cryptography-specification)
* [Compare Editor's Copy to Individual Draft](https://grittygrease.github.io/draft-sullivan-cryptography-specification/#go.draft-sullivan-cryptography-specification.diff)
* [Editor's Copy](https://cfrg.github.io/draft-irtf-cfrg-cryptography-specification/#go.draft-irtf-cfrg-cryptography-specification.html)
* [Datatracker Page](https://datatracker.ietf.org/doc/draft-irtf-cfrg-cryptography-specification)
* [Individual Draft](https://datatracker.ietf.org/doc/html/draft-irtf-cfrg-cryptography-specification)
* [Compare Editor's Copy to Individual Draft](https://cfrg.github.io/draft-irtf-cfrg-cryptography-specification/#go.draft-irtf-cfrg-cryptography-specification.diff)


## Contributing

See the
[guidelines for contributions](https://github.com/grittygrease/draft-sullivan-cryptography-specification/blob/main/CONTRIBUTING.md).
[guidelines for contributions](https://github.com/cfrg/draft-irtf-cfrg-cryptography-specification/blob/main/CONTRIBUTING.md).

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

0 comments on commit 30eda9b

Please sign in to comment.