Skip to content

vallidate-markdown failure: How should we maintain scripts across branches? #3542

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

Closed
handrews opened this issue Feb 1, 2024 · 5 comments · Fixed by #3554
Closed

vallidate-markdown failure: How should we maintain scripts across branches? #3542

handrews opened this issue Feb 1, 2024 · 5 comments · Fixed by #3554

Comments

@handrews
Copy link
Member

handrews commented Feb 1, 2024

The validate-markdown check is currently failing on all branches but main because main now has a very different JavaScript configuration from the branches. Those branches should have GitHub actions that match their environments, but currently on v3.1.1-dev and v3.2.0-dev, the JavaScript package that validate-markdown runs fails even if you just ask it for help output:

(.venv) handrews@ixat OpenAPI-Specification % npx mdv versions/3.*.md
Unexpected token '.'
(.venv) handrews@ixat OpenAPI-Specification % npx mdv --help         
Unexpected token '.'
(.venv) handrews@ixat OpenAPI-Specification %
@lornajane
Copy link
Contributor

That's a fun problem. I have a horrible feeling that it really means we should split the repo into tools and specs ... But for now I'm happy to commit to cherry pick the tools changes into the active branches of that's useful? (Make me an issue if we choose this outcome)

@handrews
Copy link
Member Author

handrews commented Feb 6, 2024

@baywet I was looking at cherry-picking changes to package.json, scripts/..., and .github/... and realized your issue labeling automation is there. Are there things we should avoid putting on the branches? It seems that we need the PR automation to run on each branch independently, but I don't want to somehow trigger extra issue runs.

@baywet
Copy link
Contributor

baywet commented Feb 6, 2024

You can safely include the changes I've made in the labelling automations. It only runs from main.
You can also safely ignore those changes, probably the safest choice if we ever have to merge those branches back to main for whatever reason.

@miqui
Copy link
Contributor

miqui commented Feb 7, 2024

@handrews - noted the version of node (used in the GitHub action)is quite old. I also opened an issue against the mdv repo asking how to display line numbers where a syntax issue occurs.

@handrews
Copy link
Member Author

handrews commented Feb 7, 2024

If someone wants to update things that can be a separate issue/PR. I'm just trying to clear out all of the things that are broken, and all of the things that are blocked from merging because of broken things.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants