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

Introduce devcontainer.json #710

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Conversation

AArnott
Copy link
Contributor

@AArnott AArnott commented Sep 5, 2023

This ensures that VS Code or GitHub Codespaces can automatically create an environment where make can build the rst files.

Learn more about GitHub Codespaces.

This root repo should consider setting up a prebuild of the Codespace because the Dockerfile takes several minutes to run, and with a prebuild, anyone can create a Codespace in seconds.

.vscode/settings.json Outdated Show resolved Hide resolved
@AArnott
Copy link
Contributor Author

AArnott commented Sep 6, 2023

You can see a sample of how Codespaces works by visiting the source branch of this PR and clicking the "<> Code" button:

image

.devcontainer/Dockerfile Outdated Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
Copy link
Collaborator

@daira daira left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good so far, changes requested.

@AArnott AArnott force-pushed the devcontainer branch 4 times, most recently from 49e9b32 to c192616 Compare September 8, 2023 12:36
devcontainer.rst Show resolved Hide resolved
Copy link
Collaborator

@daira daira left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

utACK

Copy link
Contributor Author

@AArnott AArnott left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've resolved merge conflicts.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't like that this is a duplicate / near-duplicate of Dockerfile in the root. Can it be a symlink or otherwise deduplicated (e.g. by importing one Dockerfile into another)? Otherwise it's a bitrot hazard (because most devs are unlikely to be using both of them).

This ensures that VS Code or GitHub Codespaces can automatically create an environment where `make` can build the rst files.
It also enables the rst preview pane in VS Code or GitHub Codespaces.
@AArnott
Copy link
Contributor Author

AArnott commented Nov 7, 2024

I pushed a change that eliminates the duplication. But I can't fully validate it because for some reason there's an issue with a build error that even appears (for me) on main:

make[1]: Leaving directory '/zips'
make[1]: ./edithtml.sh: No such file or directory
make[1]: *** [Makefile:51: rendered/index.html] Error 127
make: *** [Makefile:12: all-zips] Error 2

Any suggestions as to why this would show up?

Also, I'm curious why the PR doesn't include validation by running this build.

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.

3 participants