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

Add DevContainer (GitHub codespaces support and convenience commands) #3

Merged
merged 3 commits into from
Nov 14, 2024

Conversation

SeanKilleen
Copy link
Contributor

@SeanKilleen SeanKilleen commented Nov 13, 2024

Makes it easier for folks (and maintainers!) to drop into a web-based or local vscode instance and have everything you need to build & run the site locally.

This container pulls from https://github.com/SeanKilleen/blog-in-a-box-container/ , which I maintain.

In addition to a devcontainer, it adds several shortcuts for ease of use:

  • localdev - serves with livereload
  • build and serve
  • spellcheck - runs cSpell (once my follow-up PR is complete to set up the config)
  • lint - runs markdown linting (once my follow-up PR is complete to set up the config)
  • lintfix runs markdown linting with fixes. (once my follow-up PR is complete to set up the config)

@SeanKilleen SeanKilleen marked this pull request as draft November 13, 2024 03:40
@SeanKilleen
Copy link
Contributor Author

SeanKilleen commented Nov 13, 2024

Marking this as a draft so I can ensure it works locally in my vscode for this repo.

@SeanKilleen
Copy link
Contributor Author

It was time for an update to the devcontainer to support GH pages v232, so diverting to work on that a little.

@SeanKilleen SeanKilleen marked this pull request as ready for review November 13, 2024 04:17
@SeanKilleen
Copy link
Contributor Author

SeanKilleen commented Nov 13, 2024

This is ready! You can verify by opening a GitHub codespace on this branch right in your browser (or opening this branch in local vscode and then choosing "rebuild and reopen in container" from the command palette. That will load the devcontainer that's in this branch. Once it loads, you can type build or serve from the terminal. If you run serve, you'll be able to see it start up right within github codespaces.

Just verified it myself 👍 Happy to walk through it with you if you'd like.

@SeanKilleen SeanKilleen changed the title Add devcontainer Add DevContainer (GitHub codespaces support and convenience commands) Nov 13, 2024
@SeanKilleen
Copy link
Contributor Author

@merill this one is ready for review 👍 (won't bug you any more on it)

@merill
Copy link
Owner

merill commented Nov 14, 2024

This is amazing. I've never used codespaces and this is a god send compared to fighting rails versions...

Thanks you so much @SeanKilleen !

@merill merill merged commit a4d7946 into merill:master Nov 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants