Skip to content

Commit

Permalink
Setup repository for draft-ietf-core-groupcomm-bis using https://gith…
Browse files Browse the repository at this point in the history
  • Loading branch information
marco-tiloca-sics committed Mar 29, 2020
1 parent c968fc3 commit 6935c7a
Show file tree
Hide file tree
Showing 8 changed files with 233 additions and 1 deletion.
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
working_directory: ~/draft

steps:
- run:
name: "Print Configuration"
command: |
xml2rfc --version
gem list -q kramdown-rfc2629
echo -n 'mmark '; mmark --version
- restore_cache:
name: "Restoring cache - Git"
keys:
- v2-cache-git-{{ .Branch }}-{{ .Revision }}
- v2-cache-git-{{ .Branch }}
- v2-cache-git-master
- 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 '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
# 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: /.*?/
16 changes: 16 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
*.html
*.pdf
*.redxml
*.swp
*.txt
*.upload
*~
.refcache
.tags
.targets.mk
/*-[0-9][0-9].xml
archive.json
report.xml
venv/
lib
draft-ietf-core-groupcomm-bis.xml
7 changes: 7 additions & 0 deletions .note.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
<note title="Discussion Venues" removeInRFC="true">
<t>Discussion of this document takes place on the
CORE Working Group mailing list ([email protected]),
which is archived at <eref target="https://mailarchive.ietf.org/arch/browse/core/">https://mailarchive.ietf.org/arch/browse/core/</eref>.</t>
<t>Source for this draft and an issue tracker can be found at
<eref target="https://github.com/core-wg/groupcomm-bis">https://github.com/core-wg/groupcomm-bis</eref>.</t>
</note>
39 changes: 39 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
sudo: required
dist: xenial

services:
- docker

env:
DRAFT_DIR: /home/idci/draft

before_install:
- docker --version
- docker pull martinthomson/i-d-template

script:
- docker run -d -v "$PWD:/tmp/draft" --tmpfs "$DRAFT_DIR:rw,exec" --name idci
martinthomson/i-d-template sleep 300
- docker exec idci cp -rn /tmp/draft /home/idci
- docker exec -w "$DRAFT_DIR" -e CI=true -e TRAVIS
-e TRAVIS_REPO_SLUG -e TRAVIS_BRANCH -e TRAVIS_TAG -e TRAVIS_PULL_REQUEST
idci make CLONE_ARGS='--reference /home/idci/git-reference'
- docker exec idci ls -l /home/idci/draft/lib
- if [ "${TRAVIS_TAG#draft-}" == "${TRAVIS_TAG}" ]; then
docker exec -w "$DRAFT_DIR" -e CI=true -e GH_TOKEN -e TRAVIS
-e TRAVIS_REPO_SLUG -e TRAVIS_BRANCH -e TRAVIS_TAG -e TRAVIS_PULL_REQUEST
idci make ghpages;
fi

deploy:
provider: script
script:
- docker exec -w "$DRAFT_DIR" -e CI=true -e GH_TOKEN -e TRAVIS
-e TRAVIS_REPO_SLUG -e TRAVIS_BRANCH -e TRAVIS_TAG -e TRAVIS_PULL_REQUEST
idci make upload
skip_cleanup: true
on:
tags: true

after_script:
- docker container rm -f idci
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
[core working group mailing list](https://mailarchive.ietf.org/arch/browse/core/)
([subscribe](https://www.ietf.org/mailman/listinfo/core)). 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/core/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/core-wg/groupcomm-bis/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
25 changes: 24 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,24 @@
# groupcomm-bis
# Group Communication for the Constrained Application Protocol (CoAP)

This is the working area for the IETF [CORE Working Group](https://datatracker.ietf.org/wg/core/documents/) Internet-Draft, "Group Communication for the Constrained Application Protocol (CoAP)".

* [Editor's Copy](https://core-wg.github.io/groupcomm-bis/#go.draft-ietf-core-groupcomm-bis.html)
* [Working Group Draft](https://tools.ietf.org/html/draft-ietf-core-groupcomm-bis)
* [Compare Editor's Copy to Working Group Draft](https://core-wg.github.io/groupcomm-bis/#go.draft-ietf-core-groupcomm-bis.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/core-wg/groupcomm-bis/blob/master/CONTRIBUTING.md).

0 comments on commit 6935c7a

Please sign in to comment.