generated from martinthomson/internet-draft-template
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1 from martinthomson/fixup
Run setup
- Loading branch information
Showing
8 changed files
with
206 additions
and
11 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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: /.*?/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
# See http://editorconfig.org | ||
|
||
root = true | ||
|
||
[*.{md,xml,org}] | ||
charset = utf-8 | ||
insert_final_newline = true | ||
trim_trailing_whitespace = true |
Validating CODEOWNERS rules …
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
# Automatically generated CODEOWNERS | ||
# Regenerate with `make update-codeowners` | ||
draft-dawkins-iab-rfc3113bis.md [email protected] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
*.html | ||
*.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-dawkins-iab-rfc3113bis.xml | ||
package-lock.json | ||
report.xml | ||
!requirements.txt |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. | ||
## Working Group Information | ||
|
||
Discussion of this work occurs on the [Internet Architecture Board | ||
Internet Engineering Task Force mailing list](mailto:[email protected]) | ||
([archive](), | ||
[subscribe]()). | ||
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 | ||
[Internet Engineering Task Force documents](https://datatracker.ietf.org/ietf/iab/documents/). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
# License | ||
|
||
See the | ||
[guidelines for contributions](https://github.com/SpencerDawkins/rfc3113bis/blob/main/CONTRIBUTING.md). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 main https://github.com/martinthomson/i-d-template $(LIBDIR) | ||
endif |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,16 +1,30 @@ | ||
# Internet-Draft Template Repository | ||
# 3GPP-IETF Standardization Collaboration | ||
|
||
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, "3GPP-IETF Standardization Collaboration". | ||
|
||
[Read the | ||
instructions](https://github.com/martinthomson/i-d-template/blob/main/doc/TEMPLATE.md) | ||
for more information. | ||
* [Editor's Copy](https://SpencerDawkins.github.io/rfc3113bis/#go.draft-dawkins-iab-rfc3113bis.html) | ||
* [Datatracker Page](https://datatracker.ietf.org/doc/draft-dawkins-iab-rfc3113bis) | ||
* [Individual Draft](https://datatracker.ietf.org/doc/html/draft-dawkins-iab-rfc3113bis) | ||
* [Compare Editor's Copy to Individual Draft](https://SpencerDawkins.github.io/rfc3113bis/#go.draft-dawkins-iab-rfc3113bis.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/SpencerDawkins/rfc3113bis/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). |