-
Notifications
You must be signed in to change notification settings - Fork 521
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
Add slug check #831
Add slug check #831
Conversation
For added context, carpentries/styles#551 should no longer apply - this template should only now be used for workshop websites and not lessons. |
@froggleston thanks for contributing this. The equivalent check should also be added to https://github.com/carpentries/training-template/, I think? |
✅ Deploy Preview for workshop-template-previews ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
|
Yup, I'll work on this tomorrow! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good to me, thanks @froggleston 🙌
Currently when building a workshop website, there is no check to validate a repository name as a slug. This PR adds a check that will fail if the repo name does not match
YYYY-MM-DD-[site][-format]
if thecarpentry
specified in the _config.yaml is one of our official lesson programs. This will mean the workshop website will fail to build completely, and the user is guided to rename their repo in the Settings menu.When using
cp
orincubator
as thecarpentry
option, the check will only warn about the slug as this could be an incubator lesson-based workshop.