adjust setup inherited from template

This commit is contained in:
Frederik Ring 2021-04-01 17:10:29 +02:00
parent 20bb3d2d05
commit 844da42300
6 changed files with 38 additions and 223 deletions

View File

@ -1,100 +0,0 @@
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: /.*?/

View File

@ -1,32 +0,0 @@
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

View File

@ -1,49 +0,0 @@
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"

View File

@ -1,7 +1,4 @@
<note title="Discussion Venues" removeInRFC="true"> <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 <t>Source for this draft and an issue tracker can be found at
<eref target="https://github.com/offen/analyticstxt"/>.</t> <eref target="https://github.com/offen/analyticstxt"/>.</t>
</note> </note>

View File

@ -1,10 +1,10 @@
# A proposed standard which allows websites and services to disclose information about their usage of analytics software and user tracking. # analytics.txt
## 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.". 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) * [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 ## Building the Draft

View File

@ -93,9 +93,9 @@ The content of the comment may contain any ASCII or Unicode characters in the %x
Example: Example:
``` ~~~~~~~~~~
# A comment # A comment
``` ~~~~~~~~~~
Implementors SHOULD make deliberate use of comments to make an analytics.txt file more accessible for non-technical audiences. Implementors SHOULD make deliberate use of comments to make an analytics.txt file more accessible for non-technical audiences.
@ -122,9 +122,9 @@ The field MUST contain a valid email address which shall be used for inquiries a
#### Example #### Example
``` ~~~~~~~~~~
Contact: Jane Doe <jane.doe@example.com> Contact: Jane Doe <jane.doe@example.com>
``` ~~~~~~~~~~
### Collects {#collects-field} ### Collects {#collects-field}
@ -180,9 +180,9 @@ Detailed behavior like mouse movement and scrolling is recorded and can possibly
#### Example #### Example
``` ~~~~~~~~~~
Collects: url, device-type, referrer Collects: url, device-type, referrer
``` ~~~~~~~~~~
### Stores ### Stores
@ -216,9 +216,9 @@ No data is persisted on the client during the collection of usage data.
#### Example #### Example
``` ~~~~~~~~~~
Stores: 1st-party-cookies, local-storage Stores: 1st-party-cookies, local-storage
``` ~~~~~~~~~~
### Uses ### Uses
@ -249,9 +249,9 @@ Other techniques that are not described in this section are in use.
#### Example #### Example
``` ~~~~~~~~~~
Uses: script Uses: script
``` ~~~~~~~~~~
### Allows ### Allows
@ -275,9 +275,9 @@ The software does not define a way for users to opt in or opt out of the collect
#### Example #### Example
``` ~~~~~~~~~~
Allows: opt-in, opt-out Allows: opt-in, opt-out
``` ~~~~~~~~~~
### Retains ### Retains
@ -288,10 +288,10 @@ Implementors SHOULD add a comment providing a human readable value to this field
#### Example #### Example
``` ~~~~~~~~~~
# Data is retained for twelve months # Data is retained for twelve months
Retains: P12M Retains: P12M
``` ~~~~~~~~~~
### Session ### Session
@ -314,9 +314,9 @@ A user can be identified across multiple browser sessions.
#### Example #### Example
``` ~~~~~~~~~~
Session: user Session: user
``` ~~~~~~~~~~
### Variants ### Variants
@ -339,9 +339,9 @@ Content experiments are performed by grouping users into buckets based on their
#### Example #### Example
``` ~~~~~~~~~~
Variants: random Variants: random
``` ~~~~~~~~~~
### Visibility ### Visibility
@ -359,9 +359,9 @@ Usage statistics for the site or service are available to the general public.
#### Example #### Example
``` ~~~~~~~~~~
Visibility: public Visibility: public
``` ~~~~~~~~~~
### Compliance ### Compliance
@ -375,9 +375,9 @@ Example values are:
#### Example #### Example
``` ~~~~~~~~~~
Compliance: gdpr, ccpa Compliance: gdpr, ccpa
``` ~~~~~~~~~~
### Vendors ### Vendors
@ -393,16 +393,15 @@ Example values are:
#### Example #### Example
``` ~~~~~~~~~~
Vendors: offen, hotjar Vendors: offen, hotjar
``` ~~~~~~~~~~
## Examples of analytics.txt files ## Examples of analytics.txt files
### Example of a site with analytics Example of a site with analytics:
``` ~~~~~~~~~~
# analytics.txt file for https://www.analyticstxt.org
Author: Frederik Ring <hioffen@posteo.de> Author: Frederik Ring <hioffen@posteo.de>
Collects: url, referrer, device-type Collects: url, referrer, device-type
@ -419,15 +418,15 @@ Session: user
Variants: none Variants: none
Visibility: user Visibility: user
Compliance: gdpr Compliance: gdpr
``` ~~~~~~~~~~
### Example of a site not using any analytics Example of a site not using any analytics:
``` ~~~~~~~~~~
# analytics.txt file for https://www.frederikring.com # analytics.txt file for https://www.frederikring.com
Author: Frederik Ring <hioffen@posteo.de> Author: Frederik Ring <hioffen@posteo.de>
Collects: none Collects: none
``` ~~~~~~~~~~
# Location of the analytics.txt file {#location} # Location of the analytics.txt file {#location}
@ -443,9 +442,9 @@ Implementors MAY signal the location of an analytics.txt file in the context of
Example: Example:
```html ~~~~~~~~~~
<link rel="analytics" href="https://example.com/resources/analytics.txt"> <link rel="analytics" href="https://example.com/resources/analytics.txt">
``` ~~~~~~~~~~
### HTTP Header ### HTTP Header
@ -453,9 +452,9 @@ In addition to that implementors MAY send an HTTP header of `X-Analytics-Txt` wi
Example: Example:
``` ~~~~~~~~~~
X-Analytics-Txt: https://example.com/resources/analytics.txt X-Analytics-Txt: https://example.com/resources/analytics.txt
``` ~~~~~~~~~~
## Precendence ## Precendence