Comments (4)
It would be great to collect a list of specific criteria to check for, so that it can be more easily converted into an implementation. I'll try to make a start, and would extend it with everything that's posted later on. I'm annotating with "warning" for something that CI should complain about but not block a merge, and "error" for things that must not be accepted.
Root folder xep-*.xml
:
-
/xep/header/number
equals number in filename (error) - There is a new
/xep/header/revision
block in changed files, containing a version, date, initials and remark (warning)
Inbox proto-XEPs:
-
/xep/header/number
is "xxxx" or "XXXX" (warning) -
/xep/header/status
is "ProtoXEP" (warning)
Both types of XEP files:
-
/xep/header/type
is one of:- "Standards Track", "Informational", "Historical", "Humorous", "Procedural" (part of XEP-0001), "SIG Proposal", "SIG Formation" (only to be accepted in existing files) (error)
-
/xep/header/status
is one of:- "Active", "Deferred", "Deprecated", "Experimental", "Final", "Obsolete", "Proposed", "Rejected", "Retracted" (new and existing files), "Draft" (only to be accepted in existing files) (error)
from xeps.
Thank you Georg for the support!
- Estimated workload: 12 h
- Assumption: Knowledge of Github Automation
- Further clarification: Specification of the required validation rules
from xeps.
For this issue I think the deliverable just needs to be a script that accepts (at a minimum) a XEP .xml file, and returns a formatted list of issues (if any). I don't think CI stuff should be in scope (therefore the person working on this does not need any knowledge of Github automation).
from xeps.
I reformulated this with a clearer specification in #1235 and #1240, in order to have a more clean issue log. Re-open this if you disagree or comment over there or have anything to add.
from xeps.
Related Issues (20)
- some links to tools.ietf.org are broken HOT 1
- bibxml citation library HOT 6
- State license of bibliographic data
- Automate publication of new documents HOT 3
- Automate attic maintenance HOT 4
- Facilitate triaging through automation HOT 5
- Automate email notifications HOT 2
- XEP-0004: dead link to Protocol Namespaces
- Create tool to validate standalone XEP-0001 conformance
- Devise a robust, transactional system for "publishing" repository versions HOT 2
- Create tool to execute the triaging workflow HOT 4
- Create tool to facilitate automatic creation of git tags for new XEP releases
- Create tool to validate that no changes are made to a XEP after the most recent revision block in a commit range
- Integrate new tooling into pull request CI
- Integrate new tooling into main branch CI
- XEP-0390: Initiate Last Call HOT 2
- Document in attic should include disclaimer HOT 2
- XEP-0266 non-semver version string
- Failure running `xmllint` on HTML builds HOT 2
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from xeps.