mirror of
https://github.com/offen/analyticstxt.git
synced 2024-12-04 05:50:28 +01:00
Setup repository for draft-offen-analyticstxt using https://github.com/martinthomson/i-d-template
This commit is contained in:
parent
4900d4a748
commit
20bb3d2d05
100
.circleci/config.yml
Normal file
100
.circleci/config.yml
Normal file
@ -0,0 +1,100 @@
|
||||
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-
|
||||
|
||||
- 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: /.*?/
|
||||
2
.github/CODEOWNERS
vendored
Normal file
2
.github/CODEOWNERS
vendored
Normal file
@ -0,0 +1,2 @@
|
||||
# Automatically generated CODEOWNERS file.
|
||||
draft-offen-analyticstxt.md frederik.ring@gmail.com hello@niefeld.com
|
||||
32
.github/workflows/archive.yml
vendored
Normal file
32
.github/workflows/archive.yml
vendored
Normal file
@ -0,0 +1,32 @@
|
||||
name: "Archive Issues and Pull Requests"
|
||||
|
||||
on:
|
||||
schedule:
|
||||
- cron: '0 0 * * 0,2,4'
|
||||
repository_dispatch:
|
||||
types: [archive]
|
||||
|
||||
jobs:
|
||||
build:
|
||||
name: "Archive Issues and Pull Requests"
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: "Checkout"
|
||||
uses: actions/checkout@v2
|
||||
|
||||
- name: "Update Archive"
|
||||
uses: martinthomson/i-d-template@v1
|
||||
with:
|
||||
make: archive
|
||||
token: ${{ secrets.GITHUB_TOKEN }}
|
||||
|
||||
- name: "Update GitHub Pages"
|
||||
uses: martinthomson/i-d-template@v1
|
||||
with:
|
||||
make: gh-archive
|
||||
token: ${{ secrets.GITHUB_TOKEN }}
|
||||
|
||||
- name: "Save Archive"
|
||||
uses: actions/upload-artifact@v2
|
||||
with:
|
||||
path: archive.json
|
||||
58
.github/workflows/ghpages.yml
vendored
Normal file
58
.github/workflows/ghpages.yml
vendored
Normal file
@ -0,0 +1,58 @@
|
||||
name: "Update Editor's Copy"
|
||||
|
||||
on:
|
||||
push:
|
||||
paths-ignore:
|
||||
- README.md
|
||||
- CONTRIBUTING.md
|
||||
- LICENSE.md
|
||||
- .gitignore
|
||||
pull_request:
|
||||
paths-ignore:
|
||||
- README.md
|
||||
- CONTRIBUTING.md
|
||||
- LICENSE.md
|
||||
- .gitignore
|
||||
|
||||
jobs:
|
||||
build:
|
||||
name: "Update Editor's Copy"
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: "Checkout"
|
||||
uses: actions/checkout@v2
|
||||
|
||||
- name: "Cache Setup"
|
||||
id: cache-setup
|
||||
run: |
|
||||
mkdir -p "$HOME"/.cache/xml2rfc
|
||||
echo "::set-output name=path::$HOME/.cache/xml2rfc"
|
||||
date -u "+::set-output name=date::%FT%T"
|
||||
|
||||
- name: "Cache References"
|
||||
uses: actions/cache@v2
|
||||
with:
|
||||
path: |
|
||||
${{ steps.cache-setup.outputs.path }}
|
||||
.targets.mk
|
||||
key: refcache-${{ steps.cache-setup.outputs.date }}
|
||||
restore-keys: |
|
||||
refcache-${{ steps.cache-setup.outputs.date }}
|
||||
refcache-
|
||||
|
||||
- name: "Build Drafts"
|
||||
uses: martinthomson/i-d-template@v1
|
||||
|
||||
- name: "Update GitHub Pages"
|
||||
uses: martinthomson/i-d-template@v1
|
||||
if: ${{ github.event_name == 'push' }}
|
||||
with:
|
||||
make: gh-pages
|
||||
token: ${{ secrets.GITHUB_TOKEN }}
|
||||
|
||||
- name: "Archive Built Drafts"
|
||||
uses: actions/upload-artifact@v2
|
||||
with:
|
||||
path: |
|
||||
draft-*.html
|
||||
draft-*.txt
|
||||
49
.github/workflows/publish.yml
vendored
Normal file
49
.github/workflows/publish.yml
vendored
Normal file
@ -0,0 +1,49 @@
|
||||
name: "Publish New Draft Version"
|
||||
|
||||
on:
|
||||
push:
|
||||
tags:
|
||||
- "draft-*"
|
||||
|
||||
jobs:
|
||||
build:
|
||||
name: "Publish New Draft Version"
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: "Checkout"
|
||||
uses: actions/checkout@v2
|
||||
|
||||
# See https://github.com/actions/checkout/issues/290
|
||||
- name: "Get Tag Annotations"
|
||||
run: git fetch -f origin ${{ github.ref }}:${{ github.ref }}
|
||||
|
||||
- name: "Cache Setup"
|
||||
id: cache-setup
|
||||
run: |
|
||||
mkdir -p "$HOME"/.cache/xml2rfc
|
||||
echo "::set-output name=path::$HOME/.cache/xml2rfc"
|
||||
date -u "+::set-output name=date::%FT%T"
|
||||
|
||||
- name: "Cache References"
|
||||
uses: actions/cache@v2
|
||||
with:
|
||||
path: |
|
||||
${{ steps.cache-setup.outputs.path }}
|
||||
.targets.mk
|
||||
key: refcache-${{ steps.date.outputs.date }}
|
||||
restore-keys: |
|
||||
refcache-${{ steps.date.outputs.date }}
|
||||
refcache-
|
||||
|
||||
- name: "Build Drafts"
|
||||
uses: martinthomson/i-d-template@v1
|
||||
|
||||
- name: "Upload to Datatracker"
|
||||
uses: martinthomson/i-d-template@v1
|
||||
with:
|
||||
make: upload
|
||||
|
||||
- name: "Archive Submitted Drafts"
|
||||
uses: actions/upload-artifact@v2
|
||||
with:
|
||||
path: "draft-*-[0-9][0-9].xml"
|
||||
16
.gitignore
vendored
16
.gitignore
vendored
@ -1,2 +1,16 @@
|
||||
*~
|
||||
/*-[0-9][0-9].xml
|
||||
archive.json
|
||||
*.html
|
||||
*.pdf
|
||||
*.redxml
|
||||
.refcache
|
||||
|
||||
report.xml
|
||||
*.swp
|
||||
.tags
|
||||
.targets.mk
|
||||
*.txt
|
||||
*.upload
|
||||
venv/
|
||||
lib
|
||||
draft-offen-analyticstxt.xml
|
||||
|
||||
7
.note.xml
Normal file
7
.note.xml
Normal file
@ -0,0 +1,7 @@
|
||||
<note title="Discussion Venues" removeInRFC="true">
|
||||
<t>Discussion of this document takes place on the
|
||||
mailing list (analyticstxt@ietf.org),
|
||||
which is archived at <eref target="https://mailarchive.ietf.org/arch/browse/analyticstxt/"/>.</t>
|
||||
<t>Source for this draft and an issue tracker can be found at
|
||||
<eref target="https://github.com/offen/analyticstxt"/>.</t>
|
||||
</note>
|
||||
31
CONTRIBUTING.md
Normal file
31
CONTRIBUTING.md
Normal file
@ -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
|
||||
[analyticstxt working group mailing list](https://mailarchive.ietf.org/arch/browse/analyticstxt/)
|
||||
([subscribe](https://www.ietf.org/mailman/listinfo/analyticstxt)). 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/analyticstxt/documents/).
|
||||
4
LICENSE.md
Normal file
4
LICENSE.md
Normal file
@ -0,0 +1,4 @@
|
||||
# License
|
||||
|
||||
See the
|
||||
[guidelines for contributions](https://github.com/offen/analyticstxt/blob/main/CONTRIBUTING.md).
|
||||
11
Makefile
Normal file
11
Makefile
Normal file
@ -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
|
||||
26
README.md
26
README.md
@ -1,2 +1,24 @@
|
||||
# analyticstxt
|
||||
A proposed standard which allows websites and services to disclose information about their usage of analytics software and user tracking
|
||||
# A proposed standard which allows websites and services to disclose information about their usage of analytics software and user tracking.
|
||||
|
||||
This is the working area for the individual Internet-Draft, "A proposed standard which allows websites and services to disclose information about their usage of analytics software and user tracking.".
|
||||
|
||||
* [Editor's Copy](https://offen.github.io/analyticstxt/#go.draft-offen-analyticstxt.html)
|
||||
* [Individual Draft](https://datatracker.ietf.org/doc/html/draft-offen-analyticstxt)
|
||||
* [Compare Editor's Copy to Individual Draft](https://offen.github.io/analyticstxt/#go.draft-offen-analyticstxt.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/offen/analyticstxt/blob/main/CONTRIBUTING.md).
|
||||
|
||||
Loading…
Reference in New Issue
Block a user