Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create tool to facilitate automatic creation of git tags for new XEP releases #1238

Open
horazont opened this issue Nov 5, 2022 · 0 comments
Labels
Editor Tooling Issue relates to process/tooling

Comments

@horazont
Copy link
Contributor

horazont commented Nov 5, 2022

Summary

In order to find specific revisions more easily in the git tree, the Editor has started to manually tag the commits which introduce a revision block using tags of the format xep-NNNN-vX.Y.Z.

Creating those tags manually is error-prone.

Work proposal

Given two git commits (the PR head and the merge base between the PR head and the current main branch), the tool should iterate until it finds a commit which adds a revision block for any XEP (it may do so by running the generation tooling for xeplist.xml for each revision and comparing the output).

The tool should emit the resulting tags and the associated commit IDs in a machine-readable format.

Requirements

  • SHOULD NOT validate that no further changes happen to a document after the most recent tag in the commit range.

    This is left for a separate validation step.

  • MUST output a machine-readable format

  • SHOULD help human users by adding commit titles to the machine-readable format in an unambiguous way

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Editor Tooling Issue relates to process/tooling
Projects
None yet
Development

No branches or pull requests

1 participant