Skip to content

Commit

Permalink
Setup repository for draft-sullivan-tls-opaque using https://github.c…
Browse files Browse the repository at this point in the history
  • Loading branch information
grittygrease committed Mar 11, 2019
1 parent b672299 commit e53a446
Show file tree
Hide file tree
Showing 7 changed files with 172 additions and 0 deletions.
53 changes: 53 additions & 0 deletions .circleci/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
version: 2
jobs:
build:
docker:
- image: martinthomson/i-d-template:latest
working_directory: ~/draft

steps:
- checkout

# Build txt and html versions of drafts
- run:
name: "Build Drafts"
command: "make 'CLONE_ARGS=--reference ~/git-reference'"

# 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
# Save GitHub issues
- run:
name: "Save GitHub Issues"
command: "make issues || make issues DISABLE_ISSUE_FETCH=true && make gh-issues"

# Create and store artifacts
- run:
name: "Create Artifacts"
command: "make artifacts CI_ARTIFACTS=/tmp/artifacts"

- store_artifacts:
path: /tmp/artifacts


workflows:
version: 2
build:
jobs:
- build:
filters:
tags:
only: /.*?/
17 changes: 17 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
*.html
*.pdf
*.redxml
*.swp
*.txt
*.upload
*~
.refcache
.tags
.targets.mk
/*-[0-9][0-9].xml
issues.json
pulls.json
report.xml
venv/
lib
draft-sullivan-tls-opaque.xml
32 changes: 32 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
language: python
sudo: false
dist: xenial

addons:
apt:
packages:
- python-pip
- xsltproc

env:
global:
- GOPATH="${TRAVIS_BUILD_DIR}/.go_workspace"
- mmark_src=github.com/miekg/mmark/mmark
- mmark=./mmark

install:
- pip install xml2rfc
- if head -1 -q *.md | grep '^\-\-\-' >/dev/null 2>&1; then gem install --no-doc kramdown-rfc2629; fi
- if head -1 -q *.md | grep '^%%%' >/dev/null 2>&1; then go get "$mmark_src" && go build "$mmark_src"; fi

script:
- make
- make issues || make issues DISABLE_ISSUE_FETCH=true && make gh-issues
- make gh-pages

deploy:
provider: script
script: make upload
skip_cleanup: true
on:
tags: true
31 changes: 31 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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.


## Other Resources

Discussion of this work occurs on the
[tls working group mailing list](https://mailarchive.ietf.org/arch/browse/tls/)
([subscribe](https://www.ietf.org/mailman/listinfo/tls)). 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/tls/documents/).
4 changes: 4 additions & 0 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# License

See the
[guidelines for contributions](https://github.com/grittygrease/draft-sullivan-tls-opaque/blob/master/CONTRIBUTING.md).
11 changes: 11 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
@@ -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 master https://github.com/martinthomson/i-d-template $(LIBDIR)
endif
24 changes: 24 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# TODO - Your title

This is the working area for the individual Internet-Draft, "TODO - Your title".

* [Editor's Copy](https://grittygrease.github.io/draft-sullivan-tls-opaque/#go.draft-sullivan-tls-opaque.html)
* [Individual Draft](https://tools.ietf.org/html/draft-sullivan-tls-opaque)
* [Compare Editor's Copy to Individual Draft](https://grittygrease.github.io/draft-sullivan-tls-opaque/#go.draft-sullivan-tls-opaque.diff)

## Building the Draft

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

See the
[guidelines for contributions](https://github.com/grittygrease/draft-sullivan-tls-opaque/blob/master/CONTRIBUTING.md).

0 comments on commit e53a446

Please sign in to comment.